Dev Portal Overview
The Konnect Dev Portal is a customizable website for developers to locate, access, and consume API services. The Dev Portal enables developers to browse and search API documentation, test API endpoints, and manage their own credentials. Konnect offers flexible deployment options to support both internal and external APIs that can be managed from Konnect.
Publish service documentation
In Konnect, API products can be published to the Dev Portal with one click. Published API products become immediately available to users who have access to the Dev Portal. When an API product is published, the API spec and any service documentation becomes discoverable. We use the term discoverable here because the Dev Portal can create a unified API experience where a developer can navigate through the different APIs that are available, read documentation, test endpoints within the Dev Portal, and register to create applications for specific APIs.
Getting started guide: This guide walks you through importing an API spec, publishing your service and corresponding API spec to the Dev Portal, and configuring registration settings so that users can view your services and register applications.
API product documentation: This doc explains how to upload and publish product documentation using the API Products dashboard and publish services to the Dev Portal so they can be publicly consumed.
Manage Konnect API product versions: This explains how to manage the API product version for your services, including the status of the API product version. API product versions can have a status of “Published”, “Deprecated”, or “Unpublished”.
API specifications can be uploaded and attached to a specific API product version within the API Product.
You can have different API specs that correspond to different API product versions.
Konnect accepts OpenAPI (Swagger) specs in YAML or JSON.
Once you’ve uploaded the spec, you can also preview the way the spec will render, including the methods available, endpoint descriptions, and example values. You’ll also be able to filter by tag when in full-page view.
The Dev Portal lives at a separate URL from Konnect and requires that all users, including Admin roles, register as a Developer.
Developer self service
Dev Portals are created for developers to use. The Dev Portal removes the burden of credential management from the API creator, and empowers developers to manage aspects of the application development lifecycle on their own.
Developers can interact with API product versions that have been exposed through API Products via applications. They can register and unregister applications, manage their own application API keys, and view analytics for their applications from the Dev Portal.
For more information on this topic, we offer several pieces of documentation depending on your use case.
For Konnect administrators:
Enabling and disabling application registration - This explains how to grant and revoke application registration access.
Manage developer access - This doc details to a Konnect administrator all of the different options they have available to them to manage developer access to their Dev Portal. The Dev Portal offers administrators the ability to approve and reject requests for access to the Dev Portal.
Manage developer access- This doc details to a Konnect administrator all of the different options they have available to them to manage developer access to their Dev Portal. The Dev Portal offers administrators the ability to approve and reject requests for access to the Dev Portal.
Manage application registration requests - When developers want to create applications on your Dev Portal, they will have to create a request. Requests can be managed from within Konnect. This document contains instructions on how to manage application requests. If you are interested in automatically allowing application requests automatically, read our guide on handling auto approval.
Contextual developer analytics
You can view analytics for developer applications from within the Konnect Dev Portal. This gives developers the ability to gain insights into all of their applications and the relationships between applications and APIs.
Each application has its own dashboard, which provides a high-level summary of the Number of Requests, Average Error Rate, and p99 Latency, and charts for the following data points:
- Requests by version
- P99 latency by version
- Error code distribution
All of these metrics can be viewed within a selected time frame of up to Last 30 days, over a period of the last 90 days.
Free accounts only have access to a time frame of 24 hours.
Konnect has built-in customization options for managing the Dev Portal so that you can build a consistent experience for the consumers of your API. Customizing your Dev Portal to reflect the likeness of your brand can help convince developers to create applications with your services. With Konnect, you can customize everything from the application, Konnect also offers pre-built themes.
For more information please read our doc on customization.