About API Products
API Products bundles and manages multiple services. Each API product consists of at least one API product version, and each API product version is connected to a Gateway service. You can document your services and publish API products to a Developer Portal for consumption.
Access Konnect API Products.
API Products Dashboard
The API Products Dashboard is the place to manage API products, versions, and documentation. The dashboard is available by clicking any API product in API Products.
Here are some of the things you can do from the API Products Dashboard:
- Configure an API product
- Publish an API product to the Dev Portal
- Manage API product versions.
- View traffic, error, and latency data.
||Analytics data for the API product. You can configure the analytics options using the Analytics tool.
||This section displays the status of an API product version. From the context menu you can Delete an API product version, or use the View Details button to navigate to that version’s dashboard.
||You can add markdown documentation for your API product, as well as an API specification for each version of the API product. You can control the individual publishing status of each document you upload to a API product.
API product versions
A Konnect API product version is linked to a Gateway service inside a control plane. As such, the configurations or plugins that are associated with the Gateway service are also associated with the API product version.
API products can have multiple API product versions, and each version can be linked to a Gateway service. API products can be made available in multiple environments by linking API product versions to Gateway services in different control planes. You can also associate an API spec with a product version and make the spec accessible in the Dev Portal.
A common use case is environment specialization.
For example, if you have three control planes for
production, you can manage which environment the API product version is available in by
linking an API product version to a Gateway service in that control plane. You might have v1 running
production, and be actively working on v2 in
development. Once it’s
ready to test, you’d create v2 in
staging before finally creating v2 in
production alongside v1.
The analytics dashboard shown in the API product Overview is a high level overview of traffic, error, and latency for the API product. These reports are generated automatically based on the traffic to the API product.
The API product Documentation can be used to manage documentation for your API product. Once the documentation is uploaded it can be edited from the dashboard. The documentation can be accessed once the API product is published.