API Gateway on PhronIQ

Get started with API Gateway (local evaluation)

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks through standing up a local evaluation stack on a workstation with Docker Compose, and signing in to both the Admin Console and the Developer Portal for the first time.

This is not the production install. The local stack is for trying the product on one machine. A production deployment runs on Kubernetes from an offline bundle that includes every image and its own installation guide; it is delivered with your licence. To arrange an installation, email hello@phron.tech.

API Gateway administrator guide

Mon, 01 Jan 0001 00:00:00 +0000

The Admin Console (http://localhost:5173 locally) is where platform admins configure environments, publish and govern APIs, manage traffic policies and certificates, run canary/blue-green rollouts, and monitor the gateway. This guide covers every tab in the console.

All actions require an Admin Token (see Getting Started). Most actions additionally require that your token’s role grants access to the specific environment you’re acting on — see Permissions below.

Console layout

The top bar (config bar) holds the Control Plane URL, an optional Sign in with SSO field (shown only when no token is set), and the Admin Token field itself, with a Sign Out button to clear it.

API Gateway developer portal guide

Mon, 01 Jan 0001 00:00:00 +0000

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.

Troubleshoot API Gateway

Mon, 01 Jan 0001 00:00:00 +0000

This guide covers common failure modes in both the Admin Console and the Developer Portal, grounded in how the backend actually reports errors. Both apps show errors the same way: a red status banner with a role=“alert” message, immediately below the form or panel where the action was triggered — the banner text is almost always the backend’s raw error message.

General principles

Errors are surfaced verbatim. Both UIs render err.message from the failed API call directly into the error banner, so the wording you see in the console/portal is close to the literal backend error string.
No client-side rollback. In the Admin Console’s Quick Publish/Wizard flows, each step (environment → upstream → API → version → route → policies → activation) runs sequentially and reports ✓ as it succeeds. If a later step fails, the earlier steps are not undone — you’ll have a partially-created set of resources. Use the APIs tab’s Browse APIs panel to see exactly what exists, and either finish the remaining steps manually (Policies tab, etc.) or clean up.
A generic 500 doesn’t always mean “server broken.” Two specific admin console actions — activating a configuration version and publishing a route — return a 500-level error even when the underlying cause is a user-fixable validation problem (e.g. an invalid configuration snapshot). If you get an unexpected server error immediately after changing a route/policy, re-check your configuration for validity (try Preflight on the APIs tab first) before assuming an infrastructure problem.

Admin Console

“Admin Token is required” / actions are grayed out

You haven’t entered a token yet, or you cleared it with Sign Out. Paste a token or use Sign in with SSO. See Getting Started.