Private APIs are only accessible for known consumers, called clients. Each client can consume multiple APIs within API Management. The relation between client and API is defined via a contract and a plan. Every client has an individual key to access the API.

Since everything in the API Management data model exists in the context of an organization, an organization is automatically created for users who only have access to the API Developer Portal. Refer to Developer Portal for detailed explanations of the restrictions of Developer Portal users.


If you want to consume a private API, you must first register for it.
To do so, click Learn more to open the API's details page.

In the Plans section, you find all available plans for the API and information on whether approval is required for a plan.

Click Sign Up on the plan you want to register for.

Users must have a valid PAS account to consume private APIs. If you are not logged in before you click Sign up, you will be redirected to the PAS login page.

Now follow the wizard through some simple steps:

  • Create a new client: Enter the name of your client in field Search or create.

Click Create.

After a successful creation, your client is displayed in the box below.

Click Next to continue.

If your user has permission to use or create clients in various organizations, a different view will be displayed:

  • Field Organization is a drop-down and you can select the organization you want to create a new client in.
  • Below, the list of available clients for your user is displayed and you can select one directly.
  • If a client has more then one version, you can also select the client version from a drop-down list.

Click Next to continue.

In step 2, the summary displays the API-related information.

Click Confirm to send your request.

API Key and Endpoint will be provided to you after your request is approved.

A success message is displayed in the Developer Portal.

If approval is required for the API you subscribed to, you now have to wait for the approval.
If approval is not necessary to use the API, you have now access to it.

If you want to check your newly created client, switch to the My Clients tab.

Tab My Clients displays an overview of your clients and their contracts.

Your new client is displayed and labeled as Awaiting Approval. Refer to Handling Approval Requests for detailed information about the approval process in API Management.

As soon as an administrator approved your request, you will get a notification.

Now you can start using the API.

Related Pages:
Related Documentation:

  • No labels