Guidelines

As an API Producer

How to publish and manage your own APIs on this platform.

README & Guidelines / As an API Producer

In this section, we will cover several essential aspects for API producers.

Note: the steps below document the manual V1 workflow (Kong Admin Portal, Gateway Manager, API Products UI). The current architecture publishes APIs via CI/CD instead - see each sub-page's own "V2 architecture" note, and confirm with the platform team which path applies before following this manually.

1. Access to Kong Admin Portal

Obtain the access rights needed to administer exposed APIs.

2. Service gateway and route configuration

Create and configure a Service Gateway and its routes.

3. API configuration for API Portal

Declare your API and its documentation so developers can find and use it.

About the "Try it" feature

Available on every API's reference page in this portal - developers can send real test requests directly from the portal, using their own credentials, without a separate tool.