Getting started
This guide takes you from an empty account to your first API call proxied through the gateway. You will work in two places: the admin console (operators) and the developer portal (API consumers).
Sign up and create your organisation
Create an admin account at /signup. Your organisation becomes a tenant: an isolated space with its own services, routes, keys, and logs.
Register a service
In the console, register an upstream service by giving it a name and a base URL. The gateway will proxy matched traffic to this address.
Create a route
Define a route that maps a path pattern (for example /api/v1/orders) to your service. Attach policies here: allowed methods, retries, timeouts, and rate limits.
Publish to the developer portal
Publish the service to your tenant's catalogue so API consumers can discover it and request access.
Request a key in the portal
As a consumer (or while testing, yourself), sign up in the developer portal, browse the catalogue, and submit an access request. Once an operator approves it, the portal issues an API key.
Make your first call
Call any matched route under /api/* with the key in the x-api-key header:
bashcurl -H "x-api-key: gw_live_…" \ https://gateway.example.com/api/v1/orders