Catalog, locations, and proxy generation

Packages describe what can be sold. Orders describe access already purchased or assigned. Location endpoints describe what the selected package can target now.

Packages

Product definitions, pricing-related metadata, and targeting capabilities available to the authenticated account.

Orders

Active account or user access, credentials, and data context tied to a package.

Locations

Continents, countries, regions, cities, ASNs, and ISPs available for a package or deployment context.

Generation

A request that combines eligible access with the chosen targeting to return ready-to-use proxy data.

DATA FLOW

Generate access from catalog state

1. 01

   Select a package

   Read package capabilities instead of assuming every product supports every target.

   GET /packages
2. 02

   Resolve access

   Read the main-user or sub-user orders and identify the active order for that package.

   GET /orders
3. 03

   Load targeting choices

   Retrieve countries first, then narrower location or network choices as the UI needs them.

   GET /locations/countries
4. 04

   Validate the intersection

   Keep package, order, and location identifiers from the same deployment context.

5. 05

   Generate proxy data

   Send the documented package/order and targeting fields, then store only what the customer must receive.

   POST /proxies/generate

Cache the catalog safely

• Cache package and location lists by deployment and package context.
• Invalidate related locations when the selected package changes.
• Refresh after a generation validation error that indicates stale inventory.
• Do not call every location endpoint before every proxy request.
• Do not reuse catalog data across white-label deployments unless their IDs and configuration are proven identical.

Labels are presentation; IDs are integration

A city or ISP label can change formatting. Use the API-provided identifier or exact value required by the generation schema, and keep the label only for display.

Progressive location UI

1. Let the customer choose a package.
2. Load countries supported by that package.
3. Load regions only after a country is selected.
4. Load cities only when the workflow requires city precision.
5. Offer ASN and ISP filters as advanced constraints with an availability warning.

For connection-string targeting after generation, see targeting.