Your created APIs are available for your customers and their developers within the API Developer Portal.

Contents of the API Developer Portal

The API Developer Portal is fully customizable, you can determine its contents yourself (refer to Customizing the API Developer Portal for details). The default template contains the following content:

Home

Home is the landing page of the API Developer Portal. You determine yourself what is displayed on this page: In API Management, select the option Feature this API for every API that should appear on the start page (refer to API Settings > Settings for details).

Expert Advice

Use this feature to highlight some of your APIs, e.g. the most wanted or the latest APIs.

Marketplace

The Marketplace is where all published APIs are displayed. Developers can use the filter to search the whole variety of your APIs.

My Clients

In the My Clients tab, every portal user gets an overview on his clients and the APIs he subscribed to.

The navigation on the right side supports the user to browse the page.

Additional Tabs

You can customize your API Developer Portal and add further tabs, for example a tab Support to connect your own customer support service desk.

If you are interested in adding customized tabs, contact the Scheer PAS support.

User Details

If you are logged in to the API Developer Portal, your login name is displayed on top right next to Logout. Click on your login name to access your personal user details.

The information is displayed in read-only mode.

If you want to change your user preferences, click Edit User Preferences.

Notifications

This additional functionality can be found next to the Login/Logout in the right upper corner. It informs you about important events in API Management and the API Developer Portal. Refer to Notifications for further details.

The notifications can also be sent by by email. This feature must be enabled during the the setup of your Scheer PAS installation. Ask your Scheer PAS administrator for help.

APIs

The APIs are displayed as tiles. Displayed are name and description saved during the creation of the API (refer to Creating an API for details).

The API version label is displayed if more than one version of the API are available.

In addition to that, you have two options:

API Documentation

Click API Documentation to access the Swagger UI where you can test the API (refer to Testing APIs for details).

Testing of API configurations is only possible with REST APIs that are coming with an OpenAPI Specification.

API Details Page (Private API)

On the details page of a private API, you can find further information about the API such as an extended description, the available plans and if a plan requires approval.

If you want to subscribe for an API, click Sign Up in the plan you want to register for (refer to Developer Access to APIs for details).

You can also access the API Documentation and Download the API definition file here. 

If more than one version of the API is available, the latest version will be displayed on top. To see the details of earlier versions, expand the labels below the open details page. 

API Details Page (Public API)

On the details page of a Public API, users can find further information about the API such as an extended description and the public endpoint.

You can also access the API Documentation and Download the API definition file here. 

Changing the User Preferences

You can edit some of your user preferences in the external identity management.

Click Edit User Preferences to access it.

In the identity management (Keycloak), you have several options:

Editing the Personal Details

Open the Personal Info menu to adapt:

  • your email address
  • your name
  • your preferred display language

Expert Advice

It is possible to add more languages to the configuration fo your API Developer Portal. See  Administration Guide > Customizing PAS  for further information.

Click Save to apply your changes.

Changing the Password

If you want to change your password, open the Account Security menu and the Signing in submenu.

Click Update.

You will then be redirected to the Scheer PAS login page.

Use the link Forgot Password? and enter your username to receive an email with a link to reset your password.

The whole process is explained in detail in the Getting Started With Scheer PAS Guide.

Enabling Two-factor Authentication

If you want to enable the two-factor authentication, open the Account Security menu and the Signing in submenu.

Click Set up autheticator application.

Follow the instructions that are displayed on the screen.

Other User Information

Below the user preferences you will find two more tabs:

  • Identity Management: Provides internal information that may be needed when you contact our support team with API Developer Portal issues.
  • Scheer PAS API Management: Provides internal information about the API Management permissions of your user.

The API Management version you are currently working with is displayed in the footer of the API Developer Portal.

On this Page:

Related Pages:
  • No labels