Add an API integration

Prev Next

Once you have published your application you can configure integration with API(s).

You add an API integration to your Application in 2-ways, the outcome will be the same.

  1. By going to your application and the “Integrations” section and clicking “New Integration”.

  2. Or by finding your desired API from the “APIs” top menu and clicking “New Integration” on that specific APIs page, then selecting your Application

All available APIs can be found under “APIs” in the top menu.

Each API has its own details page that provides additional information: Name, Base URL, Documentation, Permission type and Permissions (OAuth Scopes). Integration with the API can be triggered directly from this page.

Your App must be compatible with the API

If your App settings are not compatible with the API then your App will not show up in the dropdown of selectable Applications.

  1. Choose one of your application(s) for which the integration is configured

DevPortal_apiIntegrationsNew

  1. Select the API permission(s) your application needs.

DevPortal_apiIntegrationsScopes

  1. If the API requires approval by API team, then add a message to them and confirm the integration request.

DevPortal_apiIntegrationsSummary

  1. Once your App (NativeSPA or Web) is integrated with the API scope(s) you must request the desired scope(s) in the /connect/authorize request using the scope parameter.
    If your App is a Service, you must request the desired scope(s) in the /connect/token request using the scope parameter.

Depending on the API configuration, scopes will be added automatically to your application, or will go through an approval process.

The Status of each integration can be checked under application's Integrations page.