3.4 Manage Subscribed APIs

Select Store > API Group > Manage Subscribed APIs

The Store allows you to subscribe or unsubscribe from the APIs in a specific API group. When you subscribe to the API, you select the subscription tier and you can see the available endpoints in the API.

3.4.1 Subscribe to an API

After you create an API group, you can view and subscribe to the available APIs in the API group. You must subscribe to the APIs to be able to use them. After you subscribe to an API you should select which subscription tier you want to use and you can see the available endpoints for the API.

To subscribe to an API:

  1. On the API group, click Manage Subscribed APIs.

  2. Search for the available APIs on the right side of the page.

  3. Select the API you want to subscribe to, then drag and drop it on the left side of the screen.

  4. To add the subscription tier or view the available endpoints:

    1. In the upper right corner of the API, click Edit.

    2. In Subscription Tier, view the subscription tier assigned to this API.

    3. In Endpoints, you can view the endpoints for the API or add roles and scopes to the endpoint.

    4. Click OK to save the changes.

  5. Click OK to save the subscriptions.

3.4.2 Unsubscribe from an API

You can subscribe from any API at any time. You might unsubscribe from an API if you no longer use the API.

To unsubscribe from an API:

  1. On the API group, click Manage Subscribed APIs.

  2. Select the subscribed API on the left side of the screen and drag it to the right side of the screen.

  3. Click OK to save the changes.

3.4.3 Add Specific Roles and Scopes to an API Endpoint

Select API > Edit > API Endpoint > Scope and Role

You can add roles and scopes to a specific API endpoint of a subscribed API. You define global roles and scopes when you create an API group. If you need more granular control to a specific API endpoint, you can add additional roles and scopes to an API endpoint if you are subscribed to the API.

To add specific roles and scopes to a subscribed API endpoint:

  1. On the API group, click Manage Subscribed APIs.

  2. On the subscribed API, click Edit.

  3. Click the appropriate endpoint.

  4. To add scopes to the endpoint:

    1. View the global scopes in the Scopes field, then click Global Scopes to view the currently assigned global scopes.

    2. In Scopes, click the plus sign.

    3. Select one or more of the additional scopes you want to add that are not in the global scopes.

    4. Click outside the list of scopes to close the list of scopes.

  5. To add roles to the endpoint:

    1. View the global roles in the Roles field, then click Global Roles to view the currently assigned global roles.

    2. In Roles, click the plus sign.

    3. Select one or more of the additional roles you want to add that are not in the global roles.

    4. Click outside the list of roles to close the list of roles.

  6. Click OK twice to save the changes.