Create an API Portal (UI)
This tutorial explains how to create an API Portal through the UI.
Introduction¶
In this tutorial, you'll learn how to create an API Portal through the UI.
You will learn how to add a title, a description, a logo and how to grant access permissions to the Portal.
Production deployments
Creating API Portals through the UI is the perfect way to effortless test permissions or visual changes like a logo or Portal descriptions.
For production deployments we highly recommend to create and customize Portals through CRDs.
Before you begin¶
Before getting started, make sure you have the following:
- Followed our tutorial about API User Management and that you're familiar with it.
- Followed our tutorial about Portal Authorization
In this tutorial, you will grant Portal permissions for the group travel-agents. If you use another group,
please make sure to replace travel-agents with your own group in the examples below.
This tutorial uses Traefik Hub agent with the name demo-agent, please make sure to match the agent name, with your agent.
Create a Portal¶
First, select Create portal in dashboard overview.
Creating an API Portal consists of three configuration parts:
| Field | Description | Required |
|---|---|---|
| General | General settings about the Portal. | Yes |
| Customization | Settings about Portal customizations, like a custom theme. | No |
| API Access Control | Configure access permissions. | Yes |
In the next steps, you will go through the tree parts and you will configure your new Portal.
General¶
Let's start with the general configuration, here you will add the name for the Portal, link it to an Agent and add the Portal and Gateway URL.
| Field | Description |
|---|---|
Name |
Name for the Portal, we recommend to use kebab-case, for example my-portal. This name is used in the dashboard to identify API Portals. |
Agent |
The Traefik Hub Agent where the APIs of the Portal are reachable. |
Portal URL |
FQDN for the Portal. Not used in this tutorial! |
Gateway URL |
FQDN for the Gateway. Not used in this tutorial! |
For this tutorial, you will use random subdomains created by Traefik Hub for your Portal and Gateway URLs.
You don't have to fill out this fields.
Production deployments
We highly recommend the use of custom domains for production deployments!
Domains generated by Traefik Hub will change with every redeployment, resulting in a new domain.
Customization¶
In the next step, it is time to set the title, the description and the logo of your Portal.
These settings will be displayed on the Portal login and landing page.
| Field | Description |
|---|---|
| Title | A title for the Portal, will be used on the login and main Portal page. |
| Description | A short description of the Portal, will be used on the main page. |
| Logo URL | You can reference images served from any URL, in this example it uses a URL pointing to GitHub. |
| Service | Name of the Kubernetes Service with a custom Portal. Not used in this tutorial! |
| Port | Port of the custom Portal Service. Not used in this tutorial! |
Service and Port are used for advanced customization and not used in this tutorial.
You can follow the tutorial about Portal customization if you want to learn more.
API Access Control¶
It is time to set up the API access. Here you will configure which APIs are accessible via the Portal.
Select Add Access Control to configure access permissions.
Give it a clear name to make it effortless to recognize what this Access Control does and select the user group you want to grant access.
As pointed out under Before you begin, this tutorial assumes that you're familiar with API User Management.
Once you're done, select Save.
Now browse to the Portal overview and check the Portal settings.
After you confirmed that everything is configured, open the link to your Portal and log in.
Congratulations, you created your first API Portal using the UI.
Summary¶
In this tutorial, you used the Hub UI to create an API Portal.
You learned how to add a description, a logo and how to add permissions.
What's next¶
- Learn more about the APIPortal CRD
- Follow the tutorial about how to create a custom theme for an API Portal