API Portal Overview

How to use the API Portal.

---

Introduction

The Traefik Hub Developer Portal is a website designed for developers to discover, access, and utilize API services. This platform serves as the space where API Users can explore, understand how to utilize the APIs, manage API Key access, and experiment with their functionalities.

Access the Portal

Follow one of the steps below to access API Portal.

1. Browse to the API Portal overview page in the dashboard and choose the API Portal you want to access. Selecting the Portal Domain will redirect you to the API Portal login screen.

https://hub.traefik.io/portals

2. Get the API Portal URL of your cluster with kubectl in the terminal and open the link in a browser to log in.

CLI Command

kubectl get apiportal

CLI Output

NAME                      URLS
traefik-hub-demo-portal   https://dev.example.com

info

The API Developer Portal is a separate site that requires its own credentials. You can’t use your Traefik Hub Dashboard credentials to log in.

For more information, please refer to the documentation about authentication & authorization.

---

Portal Overview

The list of all available APIs and API bundles is automatically provisioned according to the API Catalog Item of the API User.

API Catalog

https://portal.example.com/apis/customer-api@traefik-airlines#/

Field	Description
1	The name of the API Portal. For more information, refer to the API Portal object documentation.
2	The API catalog and applications associated with the portal.
3	The list of APIs and bundles that are available for the API User.
4	The list of endpoints available for a specific API. Select an endpoint to view its details.
5	Overview and documentation about API endpoints, including parameter and response descriptions.
6	Interactive API console to test requests and responses.
7	Manage API susbcriptions. Click the user icon to log out from the API portal.

If API versioning is configured, a drop-down menu displays the versions. The following screenshot shows an example:

https://portal.example.com

Applications

The Applications page displays the list of self-service and managed API applications. Manage app subscriptions and keys from here.

https://portal.example.com

Test an Endpoint

1. Select the API you want to use from the left-hand menu.
2. Select the endpoint you want to use.
3. Choose the authorization type for the API.
4. Paste your API Key or JWT token.
5. Set the limit.
6. Select Send API Request.
7. The endpoint returns the response.

https://portal.example.com

Read More

Please refer to the documentation about using API Keys or JWT for API authorization in the API Portal.

Custom Content

In addition to the APIs and API Bundles provisioned from the API catalog, the portal can display custom content published by API owners:

• Markdown pages appear in the portal left sidebar at the portal root, or as extra tabs next to the Documentation tab of an API or an API Bundle.
• Links appear either in the portal top navigation bar (next to API catalog and Applications) when attached to the portal, or as tabs on an API or Bundle page. Relative links open in the same browser tab; absolute links open in a new tab.

Custom content is defined declaratively using the ContentItem Custom Resource. API Publishers and Managers can also manage content from the Traefik Hub dashboard.

Log Out

Select Log out in the bottom left corner to log out from the API Portal.

Related Content

• Learn how to configure API Keys to authorize APIs.
• Learn how to use API Keys for authorization and test APIs in the Portal.
• Learn how to use JWT for authorization and test APIs in the Portal.
• Use the API Portal Template repository to create a custom API Portal.