Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
After you have logged in, you will be taken to the API Management's homepage. The user interface of API Management consists of a header bar (1), a sidebar (2) and a content area (3).
- In the header bar you can find some software and user information.
- Use the sidebar on the left to navigate through API Management.
- The content area, shows content depending on the menu item you selected from the sidebar.
Initially, it shows the API Management homepage that explains some of the main elements of API Management.
The Header Bar
The header bar is located at the top of the screen. It contains the following elements:
Icon | Function | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Click on the Scheer PAS logo to get back to the API Management homepage from wherever you are. | |||||||||||||
Click on your user name to open a menu containing the following items:
|
The Sidebar
Use the sidebar menu to navigate through the functions of API Management. |
Menu Item | Menu Options | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
APIs | My APIs | Select My APIs to display a list of all APIs belonging to organizations you are member of. | ||||||||
All APIs | Opens the API search. Use the search to find the APIs you want to consume. | |||||||||
API Catalog | Displays the searchable list of available APIs. Use the catalog to import APIs. | |||||||||
New API | Choose New API to create an API. | |||||||||
Clients | My Clients | Choose My Clients to display a list of all clients belonging to organizations you are member of. | ||||||||
New Contract | The option New Contract allows you to create a contract. | |||||||||
New Client | Select New Client to create a client. | |||||||||
Organizations | My Organizations | Pick option My Organizations to display the list of organizations you are member of. | ||||||||
All Organizations | Opens the organization search. | |||||||||
New Organization | Select New Organization to create an organization.
| |||||||||
Administration
| Manage Roles | Opens the Role Management page, where administrators can create and modify roles for users. Each role grants the user a set of permissions, allowing to do specific things within an organization. | ||||||||
Manage Gateways | On the Gateway page, administrators are able to configure the gateways on which the APIs may be published. If no gateways are configured, users will not be able to publish their APIs. | |||||||||
Export/Import Data | Export all data from the API Management into an output file or use such a file to import data into this installation.
| |||||||||
Notifications | Open the notifications to check if your have pending requests from the API Developer Portal. Notifications will be sent e.g. when someone subscribes to an API. Refer to page Notifications for detailed information.
|
Div | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
|
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
|
Otp | ||||
---|---|---|---|---|
|
|