Looking for the new Developer Portal beta docs? Try the beta now.

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.

Dev Portal use cases

You can use the following table to help you determine which Dev Portal configurations are best for your use case:

You want to…	Then use…
Publish APIs to two Dev Portals, one for internal developers and one for external partner developers	Multi-portal
Allow developers to get API keys and start using your APIs	Enable app reg and Dev Portal
Determine which users can see which APIs in Dev Portal	Assign different APIs and permissions with RBAC Teams
Self-host or visually customize your Dev Portal	Self-hosted Dev Portal
Publish documentation for your APIs	Add and publish API product documentation
Keep track of Dev Portal authentication, authorization, and access logs in a SIEM provider	Dev Portal audit logs

To see guidance on all Dev Portal configuration options for your situation, see the Dev Portal configuration preparation guide.

For more information about developer self-service with Dev Portal, we offer several pieces of documentation depending on your use case.

Konnect admin

Developers

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 application registration requests - When developers want to register applications for APIs in your Dev Portal, they will have to create a request. Registration requests can be managed from within Konnect. This document contains instructions on how to manage registration requests. If you are interested in automatically allowing applications to register for APIs automatically, see information about handling auto approval.

Contextual developer application analytics

You can view analytics for your applications from within the Konnect Dev Portal. This helps you gain insight into your consumption of different API versions, routes, and methods.

Contextual developer analytics dashboard

Figure 1: Example developer analytics dashboard

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 30 days, over a period of the last 90 days.

Thank you for your feedback.

Was this page useful?