Partner & Developer onboarding
Trying endpoints in the explorer
How a developer calls live endpoints from the API Docs explorer in your API Portal, with the subscription's own credentials injected automatically and plan, API, and version selectors.
A developer calls live endpoints from the API Docs explorer in your API Portal. The explorer is interactive, and for an active subscription it injects that subscription's own credentials automatically, so the developer sends an authenticated request without pasting a key.
What is the API Docs explorer?
The explorer renders your OpenAPI specification with an interactive editor turned on. A developer reads each endpoint, fills in parameters, and sends a request from the portal. The response appears in the same view, so the developer never leaves your portal to try a call.
The explorer appears in two places: on a product's documentation, and on the Documentation tab of an active subscription. On the subscription tab it is locked to that subscription's plan.
How are a subscription's credentials injected?
For an active subscription, the portal fetches that subscription's authorization details and writes them into the explorer. The developer does not paste anything. The credentials injected depend on the plan's auth type.
| Plan auth type | What the explorer injects |
|---|---|
| API key | The subscription's API key. |
| Client Secret Basic | The Client ID and Client Secret. |
| Intermediate JWT | The Client ID and Client Secret. |
| Advanced code flow | The Client ID and Client Secret. |
A masked value is never injected. If the portal holds only an obfuscated secret, the explorer leaves that field empty rather than sending a masked string.
How does a developer pick the plan, API, and version?
The explorer shows up to three selectors above the documentation: Plan, API, and Version. The API and Version selectors appear only when there is more than one option to choose from.
| Selector | When it appears | What it does |
|---|---|---|
| Plan | When the view is not locked to a single plan. | Switches the documentation to another plan in the product. |
| API | When the plan documents at its API level and has more than one API. | Filters to one API's documentation. |
| Version | When the selected documentation has more than one visible version. | Switches to a specific version. |
On a subscription's Documentation tab the Plan selector is locked to that subscription's plan, so the developer sees only the plan they subscribed to, plus a sandbox option where one exists.
How does a developer open the explorer full screen?
The explorer header carries a Launch in full screen mode link. It opens the specification on its own page with the same Plan, API, and Version selectors, plus the developer's active subscription. A Minimize Docs control returns to the previous view.
The full-screen page also shows whether the active team has a subscription to the plan, with a link to manage it, or a Subscribe? prompt when there is none.
Can a developer try sandbox endpoints?
Yes, when the plan has a sandbox that carries its own documentation. The Plan selector adds a Sandbox option, and the explorer loads the sandbox specification when it is chosen.
A subscription that is still in sandbox, in review, or returned for changes defaults to the sandbox documentation. See From sandbox to production for the phases.
Why this matters
The explorer lets a developer call your real endpoints with real credentials from inside your portal. The developer evaluates and integrates without building a client first, and you keep that activity on your branded surface rather than sending developers to a separate tool.
This depends on the developer holding an active subscription, because the injected credentials come from the subscription. See API credentials for how a developer creates those credentials.