Application Registration

Getting Access

Any access to an API requires a set of credentials. Since these are highly confidential, we highly recommend that every user creates their own set of credentials. To acquire your own set of credentials, you first have to register your application.

Registering your first application

To register an application:

1. Log in to the CX Cloud API Gateway Portal.
2. Click the Create Access Key button.
3. Provide the name of your application.
4. Select BCS Operational Insights API.
5. Select the company from the drop-down list.
6. Check the I agree to the terms of service checkbox.
7. Click REGISTER.

NOTE: If you don't see your company listed under Company Name and Region it means your user is not authorized, see User onboarding.

The Client ID, Client Secret and region in which the data is stored are displayed:

NOTE: Copy and store the Client ID and Client Secret in a safe place - you cannot see the Client Secret again, though you can regenerate if it is lost.

NOTE: Take note of the region in which the data is stored as you will need this to construct the url to make API calls.

For application registration, make note of the following points:

• API users can register multiple applications.
• A single application registration is linked to a single company.
• Registering an application generates a set of credentials - the Client ID and Client Secret - which are submitted in the token request.
• These credentials are secrets unique to the registered application, and must be carefully protected, just as a username/password would be. They do not expire; however, they can be revoked/regenerated in the CX Cloud API Gateway Portal by the API user if they are ever compromised (this will likely require re-populating the ID/secret into the runtime configuration of any apps using the old set of secrets).
• Each application is limited to 10 calls per second and 10.000 calls per day.

Managing and monitoring applications

Once an application is registered, you can view it from the list in the CX Cloud API Gateway Portal:

For each of the applications, you can:

• Activate/Inactivate the application: If the status is set to Inactive, the application will no longer be authorized anymore to obtain a token and API requests using already generated tokens will no longer be authorized either.
• Edit the application which allows you to update the Application Name and description.
• Delete the application.
• View info on the application.

Data onboarding

The first time an application is created for a given company, the data needs to be onboarded and this can take up to an hour. If you see the highlighted paragraph in the following screenshot it means that data onboarding has been initiated:

When the highlighted paragraph is not displayed, it means the data is already onboarded. You can check the status of the data onboarding by clicking on the info icon next to your application in the application overview; if the value is "Pending" it means data onboarding is still in progress and the BCS OI API cannot be consumed yet for this company. When the value changes to "Yes" the BCS OI API is ready to be consumed.

With registration complete, applications can start requesting JWT access tokens and use them for API requests.