Developer Portal Overview¶
The Developer Portal is a self-hosted web application that acts as the front door between your APIs and the developers who consume them. API publishers register APIs and MCP servers in the portal, and developers discover, subscribe, and generate credentials — all without needing direct access to the underlying gateway or infrastructure.
New to the portal's building blocks? See Concepts for a glossary of organizations, views, APIs, subscription plans, applications, subscriptions, and API keys.
What the Developer Portal Manages¶
API and MCP Catalog¶
Browse and search REST, AsyncAPI, GraphQL, and SOAP APIs, as well as MCP servers, with full documentation and a try-out console.
- Full-text search by name, type, version, and description
- Per-API documentation, landing page content, icons, and banners
- Machine-readable discovery (
llms.txt, per-API Markdown, OpenAPI/AsyncAPI specs) built for AI agent consumption
Learn more in Discover APIs and AI Agent Discovery.
Developer Applications¶
Logical containers for OAuth2 credentials. A developer can create multiple applications — for example, one per client or environment — each linked to independent OAuth2 client IDs.
Learn more in Manage Applications.
Subscriptions and Plans¶
Developers subscribe directly to an API under a named plan (for example, Gold or Free) that enforces rate limits and quotas. No application is required to subscribe.
Learn more in Manage Subscriptions and, for admins, Subscription Plans.
API Keys and OAuth2 Credentials¶
Generate, rotate, and revoke API keys bound to a specific API. For OAuth2-secured APIs, link a client ID created in a key manager to an application and generate access tokens through the portal.
Learn more in Manage API Keys, Consume an API Secured with OAuth2, and, for admins, Key Manager Integration.
API Workflows¶
Multi-step API call sequences authored in Arazzo format and published for both human developers and AI agents to discover and follow.
Learn more in API Workflows.
Theming¶
Upload a custom theme (styles, layout, partials, and images) for a view, or reset it back to the built-in default.
Learn more in Theming.
Admin Settings¶
The Settings page is where admins configure everything above from one place: organization details, views, labels, subscription plans, key managers, the API and MCP catalog, webhooks, LLM instructions, and API workflows.
| Section | Configure |
|---|---|
| Organization Settings | Display name, business owner contact, IDP reference ID |
| Manage Views | Filtered, branded subsets of the catalog for different audiences |
| Manage Labels | Tags that control which views an API appears in |
| Subscription Plans | Rate/quota tiers applications can subscribe to |
| Key Manager Integration | OAuth2 authorization servers used to issue access tokens |
| Manage APIs | Add, edit, publish, deprecate, and delete APIs |
| Manage MCP Servers | Add, edit, publish, deprecate, and delete MCP servers |
| Webhook Integration | Endpoints notified when API keys or subscriptions change |
| LLM Instructions | Portal-level context published to llms.txt for AI agents |
| Managing API Workflows | Author, publish, and control visibility of API workflows |
| Theming | Upload, download, and reset a view's custom theme |
Gateway-Agnostic, Unified Developer Experience¶
The portal doesn't embed gateway-specific logic. Instead, it communicates with gateways through a generic webhook event outbox: whenever a developer generates an API key, subscribes, or revokes a key, the portal fires a signed event to every registered gateway subscriber, and each gateway adapter enforces access in its own way.
This means you can:
- Connect multiple gateways of different types to the same portal simultaneously
- Replace or swap a gateway without changing how developers interact with the portal
- Run the portal in a fully standalone mode (no live gateway required) and replay events later
Views¶
Within your organization you can define multiple views for different audiences — for example, one for internal teams and one for external partners.
Setting Up¶
Beyond the Docker Compose quick start, a production deployment typically needs:
| Topic | Covers |
|---|---|
| Integrate Third-Party Identity Providers | OIDC configuration reference, Asgardeo and Keycloak walkthroughs |
| Devportal Mode | Run in API Portal, MCP Hub, or API & MCP Portal mode |
| Design Mode | Develop and preview themes/layouts offline, without a database or IDP |
References¶
| Topic | Covers |
|---|---|
| Management API | Full reference for every Developer Portal REST API resource |
| Get a Bearer Token via curl | Scripted/CI access to the REST API under IDP mode |
| Configurations | Full config.toml field reference and environment interpolation |
Getting Started¶
To start using the Developer Portal, follow the Getting Started guide.