API Developer Portal — @api-developer-portal

An API without a portal onboards developers by email: keys issued manually, docs sent as links, usage questions answered by an engineer with a database query. The API Developer Portal sprint replaces that with self-service — developers discover your APIs, read live documentation, register applications, obtain credentials, and reach their first successful call without a human in the loop.

The finish state is measured by exactly that: time-to-first-call for a new developer, tracked from signup. Behind it sit credential lifecycle management, per-application usage visibility, plan-based rate limits, and the support surfaces that catch developers before they churn — whether your API serves partners, customers, or a public ecosystem.

API Discovery & Documentation

An API catalog with reference generated from your OpenAPI or GraphQL definitions, interactive try-it calls, and getting-started guides for the core use cases.

Self-Service Credentials

Developer registration, application creation, and key or OAuth-client issuance with scopes, rotation, and revocation — integrated with your gateway so credentials are live at once.

Usage Dashboards & Limits

Per-application usage, error, and quota views for developers, plan-based rate limiting, and an admin view of consumer activity across the program.

Onboarding & Support Flows

A signup-to-first-call path designed and instrumented, plus changelog, status, and support-request surfaces that keep integrations healthy after launch.

1. Scope — Fix audience, API set, and gateway integration; define plans, limits, and the target time-to-first-call.
2. Build — Build portal, credential flows, and dashboards; run pilot developers through onboarding and fix where they stumble.
3. Handover — Launch to the full audience with program-admin training and the onboarding funnel metrics live.

The API Developer Portal is a menu item on the Scrums.com delivery catalog, available at every plan tier. Add it to your plan backlog and your delivery team schedules it like any other item — scoped, tracked, and reported through the SEOP. See Delivery Plan Tiers.

Do we need an API gateway first?

The portal needs a gateway to enforce credentials and limits. If you have one, the portal integrates with it; if not, the API Gateway & Rate Limiting Setup is the prerequisite menu item and the two sequence cleanly.

Portal product or custom build?

Gateway-native portals are fastest where they fit your branding and flows; a custom portal wins for monetization, complex partner models, or deep product integration. Scoping compares both against your program.

Is this the same as a documentation portal?

No — docs are one component here. If developers only need excellent documentation without self-service keys and usage, the Developer Documentation Portal is the lighter item.