Skip to main content

Dashboard and Collections

After signing in to the Developer Portal, you land on the consumer dashboard. This page shows all API collections assigned to your client and gives you quick access to auth headers and API exploration.

Consumer dashboard​

The dashboard shows:

  • All API collections the client is assigned to
  • Collection name, description, and number of published endpoints
  • Quick-access links to browse endpoints and download OpenAPI specs

If a collection is not visible, your admin needs to assign it to the client and publish it.

Opening a collection​

Click on any collection to open the collection detail page. From here you can:

  • Browse all published endpoints
  • View the collection base path
  • Access the Auth Headers panel
  • Download the OpenAPI specification

Auth Headers panel​

The collection detail page includes an Auth Headers panel showing the three headers required for every gateway request:

HeaderValueAction
X-Client-IDYour client's IDIndividual copy button
X-Profile-IDThe currently selected profile's IDIndividual copy button
AuthorizationBearer <token> for the selected profileIndividual copy button

The values update automatically when you switch profiles using the profile selector.

Using the auth headers:

  1. Click the copy button next to any header.
  2. Paste into your API client, curl command, or code.
  3. Switch profiles to get the headers for a different access level.

Downloading the OpenAPI spec​

Every collection has a downloadable OpenAPI specification generated from its proxy definitions. Two formats are available:

FormatSchema keyword supportBest for
OpenAPI 3.0JSON Schema draft-07 subsetMost compatible — works with Postman, Swagger UI, most code generators
OpenAPI 3.1Full JSON Schema 2020-12Maximum schema expressiveness (unevaluatedProperties, $defs, etc.)

Click Download OpenAPI and select your preferred version.