Step 5—Create client apps for API access

API developers and API Central Service administrators and can create client apps to manage how API proxies are consumed. An API Central Service app is typically a representation of a mobile app developed by an application developer, and enables you to manage authentication and access to API proxies.

Create a client app

To create a client app:

  1. Click Apps in the menu on the left, and click + App at the top right.
  2. Enter the required app name (description and tags are optional).
  1. Click Save at the top right.
Note   An app can belong to one team only to enforce access per team. For more details, see Ensure your team has access to the API proxy.

Generate an API key for an app

To generate an API key for an app:

  1. Click Apps in the menu on the left, and select an app in the list to display its details.
  2. On the Authentication tab, click + Authentication on the right to add an API key.
  3. In the Validity section, if you wish to configure a date for which the key is valid, enter Valid from and Valid to dates.
  4. Click Save.

Generate API keys for apps

Tip   When the API key has been created, you can use it to authenticate to an API proxy if the API key security policy has been configured.

Ensure your team has access to the API proxy

Before you can grant an app access to an API proxy, you must first ensure that your specific user team has access to that API proxy. This is because team members can only view the API proxies that their team has been granted access to by an API Central Service administrator.

To grant the team access to API proxies, the API Central Service administrator must do the following:

  1. Click Registry > Teams in the menu on the left, and click a team in the list.
  2. Click the APIs tab, and click + API on the right.
  3. Select the APIs that you wish to grant access to, and click Add APIs.

For more details, see Step 9—Manage teams and users.

Grant an app access to API proxies

Note   You must first ensure that your team has access to the API proxy (see the previous section).

To authorize an app with API proxy access:

  1. Click Apps in the menu on the left, and select an app in the list to display its details.
  2. Click the API tab, and click the + API button to view the list of API proxies.
  3. Select the relevant APIs from the list, and click Add APIs to grant access.

Grant an app access to an API

Related topics

Step 6—Test a deployed API proxy

API Central Service concepts

Related Links