Developer Portal
The Developer Portal is a self-service web interface for API consumers. It lets developers and partners explore your API catalog, test endpoints in the browser, and download OpenAPI specifications — without access to the operations console.
Consumer journey guides
- Request magic link
- Validate link and session
- Dashboard and collections
- Explore endpoints
- Profile switching
- Testing console
- cURL and OpenAPI
What the portal provides
| Feature | Description |
|---|---|
| API discovery | Browse all collections and endpoints assigned to the client |
| Interactive testing | Send real requests directly from the browser |
| cURL generation | Auto-generate copy-paste cURL commands |
| OpenAPI download | Download API specs in OpenAPI 3.0/3.1 format |
| Profile switching | Switch between access profiles (e.g., sandbox vs production) |
| Passwordless login | Sign in via a magic link sent to email — no password needed |
| Zerq Copilot for Gateway | AI assistant with Gateway MCP (collections, endpoints, test calls) — same UX patterns as management Copilot; requires a selected profile and server-side LLM config — see Zerq Copilot |
How it works
- Admin setup: create/update a client, assign collections, enable portal access, and whitelist consumer emails.
- Consumer sign-in: request and use a magic link to authenticate.
- Scoped visibility: the portal shows only collections/proxies assigned to that client.
- Self-service usage: consumers browse endpoints, run test calls, and download OpenAPI specs.
Who can access the portal?
Access to the Developer Portal is controlled by the platform admin:
- A Client must have Developer Portal access enabled
- Only authorized email addresses listed on the client can sign in
- Once signed in, consumers see only the collections assigned to their client
This ensures partners only see what they're allowed to see.
URL
The Developer Portal runs at http://localhost:3001 in local development (or your configured domain in production).
Platform operators can surface it from the Zerq console sidebar (next to Documentation) by setting the management frontend env var NEXT_PUBLIC_DEVELOPER_PORTAL_URL to the portal’s public origin (for example https://devportal.zerq.dev).
Next steps
- Getting Access — how to sign in and set up access
- Exploring APIs — browse collections, test endpoints, download specs