Edit this page
Report an issueCreate a Dev Portal
The Konnect Dev Portal is a customizable website for developers to locate, access, and consume API services.
This is documentation for Konnect’s new Dev Portal BETA. Be aware of potential instability compared to our classic Dev Portal
When referring to Konnect APIs for the Beta (Dev Portal and APIs), please use
v3.
Get started
Your Dev Portal use case might dictate different security settings tailored to your audience. While this is not comprehensive of all possibilities, these are typical scenarios. Keep in mind it’s quite common to have multiple Dev Portals with APIs shared across them.
Figure 1: Common visibility and access control combinations
Internal Dev Portal
- Create a portal with Private visibility / Auth enabled.
- Publish all internal APIs, secured to internal use only.
- Create Pages to document API standards, training and guidance for the developers at your organization to accelerate and standardize API development and consumption.
- Secure portal via IdP integration, to ensure only organizational members have access, and segment access by Teams.
Partner Dev Portal
- Create a portal with Private visibility / Auth enabled. Auth enabling the portal will provide Developers self-service API key provisioning.
- If publicly available Pages and API specs are preferred, only requiring login for Developers in order to create Applications / provision API keys, change default visibility of the portal to Public.
- Configure RBAC defaults to restrict access to view a selection of APIs, as well as determine which APIs can provide self-service API keys.
- Publish a selection of available APIs and related documentation suited to your network of partners.
- Create a branded experience, and document benefits of your partner APIs with Portal Editor.
- Create usage guide Pages to provide context on how to enable use cases across multiple APIs.
Public Dev Portal
- Create a new Dev Portal with Public visibility and no auth.
- Publish a selection of available APIs suited to any developer.
- Craft highly customized pages for landing pages, guides, etc, and customize header & footer menus and optimize SEO.
Create Dev Portal
The only required choices are “Private” or “Public”, and provide a name for the Dev Portal. Optionally, you can specify the first API specification to publish.
Figure 1: Create a new Dev Portal
Access control
During portal creation, “Private” and “Public” change a variety of settings to streamline your onboarding. They can all be changed later in Settings/Security.
Private
- Enables User Authentication
- Default Page visibility: Private
- Default API visibility: Private
Public
- Disables User Authentication
- Default Page visibility: Private
- Default API visibility: Private
Upload your first API
Optionally, you can create and publish your first API by uploading an OpenAPI 3.x specification. If you are creating more than one Dev Portal or have previously uploaded APIs, you can also select from a list of existing APIs.
Appearance
After clicking Next, your Dev Portal will be created, and you’ll be presented with basic options to customize the look and feel. You will immedately see the template preview change according to your choices.
Appearance settings can be changed later in Portal Editor in the Appearance tab.
Next steps
Configure developer self-service
Customize
Publish API specs and documentation
Configure audit logs
- Audit logs: Keep track of Dev Portal authentication, authorization, and access logs in a SIEM provider
