API Gateway developer portal guide

The Developer Portal (http://localhost:5174 locally) is where API consumers browse the API catalog, register applications, request access, and manage the API keys and subscriptions those applications use.

Signing in

See Getting Started for the first-login walkthrough.

• Local/development deployments: email-only, passwordless login. Enter Email and optional Display Name, click Log In. Dev-only — this is explicitly disabled in production deployments, where real identity verification is required instead.
• Session behavior: your session token is valid for 8 hours. It’s stored both as an httpOnly cookie and in the browser session. If a request comes back unauthorized, the portal automatically signs you out and returns you to the login screen — there’s no separate “your session expired” message, just a return to the login form (see Troubleshooting for what this looks like).
• Sign Out is available from the top navigation once logged in.

Once signed in you land on the Catalog view. The top navigation offers: Catalog, My Applications, Create Application, Test, and Developer Onboarding, plus your name/email and Sign Out.

Any active announcements from the platform team (informational, warning, or critical) appear as banners just below the header.

Recommended path: the Developer Onboarding wizard

Goal: Go from zero to a working access request in four guided steps — the fastest path for a first-time user.

Click Developer Onboarding in the top nav. Steps:

1. Welcome — overview of what the wizard does (create an application, browse/select an API, request access, get credentials). Click Get Started.
2. App — enter an App Name (required) and optional Description and Organization / Team.
3. API — search the catalog and click a result card to select it (selection is required to proceed).
4. Review — confirms the application name, selected API, and organization, then Submit Request creates the application and submits an access request in one action.
5. Done — confirms the request was submitted and explains what happens next (an admin reviews it; once approved, you get credentials).

Note: If you reach this wizard while not signed in, submitting runs in a harmless “demo mode” that doesn’t create anything real — sign in first if you want the request to actually go through.

Manual path

If you’d rather work through the individual screens instead of the wizard:

1. Browse the API Catalog

Goal: Find an API to consume.

Go to Catalog, type a search term, press Enter or click Search. Each result card shows the API name, slug, and summary, with two actions:

• View Details — shows the full description, visibility, changelog, any deprecation notice, and the complete OpenAPI spec.
• Create App & Request Access — the fast path: creates a new application named after the API and immediately submits an access request for it, in one click. If a pending or approved request already exists for that exact app/API pair, the portal tells you instead of creating a duplicate. Against a publicly visible catalog entry, the request is auto-approved instantly and the portal also issues an API key for the new application in the same step — confirmed with a banner reading “Access approved. New API key: agw_live_...” — so verify you’ve copied it here rather than assuming you still need to visit Create Credential on My Applications afterward.

If your search returns nothing, the portal shows “No APIs match your search. Try a different search term.”

2. Create an application (standalone)

Goal: Register an application before you’ve picked a specific API, or add a second application.

Click Create Application in the top nav. If you haven’t selected or viewed any API from the catalog yet, the portal will ask you to pick one first (it needs to know which environment the application belongs to). Applications are named automatically with a timestamp suffix; if you’ve selected an Organization first (see below), it’s recorded as the application’s owner.

3. Manage applications, credentials, and subscriptions

Go to My Applications. Each application card offers:

• Create Credential — issues a new API key for the application. The raw key is shown once in the status banner — copy it immediately, it cannot be retrieved again afterward.
• View Usage — jumps to the Usage view (below).
• Show Keys / Hide Details — expands the card to reveal:
  • Credentials — each key’s prefix (not the full key), status (active/revoked), and expiry if set. Rotate issues a new key and invalidates the old one (use this if a key may have been compromised); Revoke permanently disables a key.
  • Subscriptions — API Product plans this application is subscribed to, with status (Active grants access; Suspended/Cancelled do not) and start/end dates. Browse Products loads available API Products and their Plans (rate limits per minute, with a Default badge on the default plan); click Subscribe on a plan to subscribe the application.
  • Request Access — pick a catalog entry from the dropdown and Submit to request access for this specific application (an alternative to the catalog’s one-click “Create App & Request Access” when the application already exists).
  • Access Requests — a live list of this developer’s requests with their status.

4. Organizations / teams

At the bottom of My Applications, you can create and select an Organization / Team (a name is enough). Once selected, it’s used as the owner value for new applications you create. Clear deselects it.

5. Check usage

View Usage on an application shows, per API: request count, error count, quota used vs. quota limit, and the reporting window.

API Test Console

Goal: Exercise an API directly from the browser without leaving the portal — useful for verifying a key works or exploring a response shape.

Go to Test. Choose an HTTP Method, enter the full request URL, add any Headers (a Content-Type: application/json header is pre-filled), and for POST/PUT/PATCH a JSON Body. Click Send Request (or press Ctrl+Enter / Cmd+Enter).

The response panel shows the status code, latency in ms, response headers, and a formatted body, plus a Copy as cURL button to reuse the exact request from a terminal.

Save Request stores the current method/URL/headers/body under a name for reuse later (session-local). Request History keeps your last 10 sent requests for the session, with a Clear History action.

Dev-only vs. production behavior

See also

• Admin Console Guide — Portal Approvals for how your access requests get reviewed.
• Troubleshooting for what to do if login, access requests, or credential creation fail.