Skip to content
Apiway Docs

Developer Portal

The Developer Portal is the consumer-facing view of your API catalogue. It’s where developers discover APIs, read documentation, subscribe, and manage their credentials.

What Consumers See

Section titled “What Consumers See”

The portal presents a unified catalogue of all APIs available to a consumer:

  • Produced APIs — APIs your organisation publishes
  • Consumed APIs — External APIs your organisation subscribes to
  • Marketplace APIs — APIs from other organisations available for subscription

Each API listing shows:

InformationSource
Name and descriptionOAS info section
Endpoints and operationsOAS paths
Request/response schemasOAS components
Authentication requirementsOAS security
SLA tiers and pricingOpenSLA definition
Compliance scoreCompliance service

API Documentation

Section titled “API Documentation”

API documentation is generated directly from the OpenAPI specification. Apiway renders interactive docs where consumers can:

  • Browse endpoints and operations
  • View request/response schemas with examples
  • See authentication requirements
  • Understand rate limits and quotas

Subscribing

Section titled “Subscribing”

Consumers subscribe to APIs to get access. The subscription flow:

  1. Browse the catalogue and find an API
  2. Select an SLA tier (if the producer defines multiple tiers)
  3. Submit a subscription request
  4. Governance review (if configured by the producer)
  5. Credentials provisioned automatically on approval
  6. Start calling the API

See Subscribing to APIs for the full flow.

Self-Service

Section titled “Self-Service”

The portal is designed for self-service. Consumers don’t need to email the API team or wait for manual provisioning. The flow is:

  • Subscribe → governance review → credentials → go

For internal APIs with auto-approval, this is instant. For external or production APIs, governance adds the appropriate oversight.

In This Section

Section titled “In This Section”