Skip to main content

Applications

To access an API Product, consumers must first create an application. Applications serve as the identity for API access — API keys and credentials are linked to an application, not directly to a user. This design allows administrators to manage access at the application level: deactivating a single application revokes its access to all subscribed APIs.

Applications can be created by administrators through the Management API, or by consumers through a Developer Portal. Each application can have multiple subscriptions to different API Products, each with its own plan.

Key concepts​

  • Application — A consumer client that subscribes to API Products. API keys are bound to the application, making it the unit of access control
  • Custom fields — Tenant-defined metadata fields that you can add to all applications (e.g., cost center, team name, project ID). Useful for tracking and governance
  • Credentials — Client IDs and secrets issued by the gateway when a subscription is deployed. The format depends on the gateway platform
  • Deployment — Like APIs and products, applications must be deployed to environments. Subscribing to a product automatically triggers deployment of the application to the relevant environments