Developer Access to APIs

As a developer, you can access API information through the API Developer Portal. All available APIs are displayed in the portal (refer to Managing the Developer Portal for details). Depending on the type of the API, you can directly use it (public APIs) or need to subscribe for it (private APIs).

The chosen visibility of a public API or a plan for private APIs determines the content of the Developer Portal that a user is allowed to see. Relevant for the visibility is the identity management (IDM) group a user belongs to. Refer to The Concepts of API Management > Visibility for details.

Using the API Developer Portal

The APIs in the portal are displayed as tiles showing:

• Name

• Description

• Version Label (displayed only when more than one version is available)

• API Documentation

• Learn more

API Documentation

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

API Details Page

Private APIs: On the details page of a private API, users 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 to an API, click Sign Up on the plan you want to register for. Refer to Subscribing to a Private API for details.

You can also access the API Documentation and use option Download the API definition file. 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:

Public APIs: 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. Refer to Consuming a Public API for details.

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