Partner & Developer onboarding

This track describes how a developer or partner onboards in your API Portal, from finding an API to calling it in production. Your API Portal is white-labelled, so this is the experience your developers go through on your domain, under your brand.

What is the developer journey in your API Portal?

A developer discovers an API, subscribes to a plan, generates credentials, calls endpoints, and where the plan uses a sandbox, moves from sandbox to production after your review. The plan a developer chooses decides which of these steps apply.

1. Discover. A developer browses your API catalog and opens a product to compare its plans.
2. Subscribe. They pick a plan and run the subscription wizard. The plan type decides what happens next: active immediately, payment, or an approval request.
3. Get credentials. They generate the credentials their plan grants, an API key or OAuth2 client credentials.
4. Call endpoints. They authenticate and call the API.
5. Sandbox to production. On a sandbox-enabled plan, they build against sandbox credentials, submit for review, and receive production credentials after your team approves.

What decides whether a subscription is active right away?

The plan does. A free plan activates at once. A paid plan sends the developer through checkout first. A plan with an approval group holds the subscription as pending until your team approves it. A sandbox plan starts in sandbox and unlocks production after review.

See Subscribing to a plan for each branch and what every subscription status means.

Where do developers manage their access?

Each developer works inside a team in your portal. The team holds the subscriptions, and each subscription holds its own credentials and, on scope-based plans, its own granted scopes. A developer requests more access from the subscription's Your Access view.

See Your access for how a developer requests Optional and Restricted scopes and how your team approves them.

Start here