Applications for API Access
Register an application here to give it access to the Bright Pattern Contact Center APIs. Each application authenticates with generated credentials and an access token, and it acts on behalf of an associated user, so its API access carries that user's permissions.
This page lists applications granted API access and lets you add, review, edit, and delete their registrations.
Each registered application is shown with its Name, Client ID, Associated User, and Access Token Valid For period. Use the actions menu (⋮) at the end of a row to edit or delete an application.
Adding an application
Click Add Application to open the Add Application dialog.
Provide the following, then click Add:
Name
A name that identifies the application. This is required and can be changed later.
Associated User
The user account whose permissions the application's API calls will carry. This is required. Select the user from the list. You can change the associated user after creation.
Access Token Valid For
How long an access token issued to this application remains valid. Enter a number and choose a unit. The default is 6 months, the maximum is 12 months, and the minimum is 1 hour. You can change this value after creation.
Reviewing application details
When you add an application, the Review Application Details dialog appears. It shows the values you entered, such as the Associated User and Access Token Valid For period, together with the generated credentials and a button to request an access token.
Client ID
A generated identifier (26 alphanumeric characters) for the application. It is created automatically, cannot be changed, and is used together with the Client Secret to authenticate the application. Use the copy button to copy it.
Client Secret
A generated secret that the application uses, together with its Client ID, to authenticate when requesting tokens.
|
The Client Secret is shown only once, at creation time. Copy it and store it securely before closing the dialog: it cannot be viewed again afterward, either in the table or when editing the application. | |
Access Token
An access token is the bearer token that the application includes in its API requests to authenticate. It is bound to the Associated User, so requests made with it carry that user's permissions, and it remains valid for the Access Token Valid For period.
The access token is not generated automatically with the application. Click Request Access Token to generate it, in the same way that the Client Secret is generated when the application is created. An access token can be requested only from this dialog, immediately after the application is created.
|
|
You have only one chance to copy the access token. Like the Client Secret, it is shown only once: copy it and store it securely before closing the dialog, because it cannot be retrieved afterward. Use the reveal button to display it and the copy button to copy it. | |
Editing and deleting an application
Use the actions menu (⋮) on an application's row to edit or delete it. You can change the Name, Associated User, and Access Token Valid For period of an existing application; the Client ID cannot be changed, and the Client Secret and access token cannot be viewed again after creation.
When you delete an API application, its API access is terminated and all of its tokens are invalidated. You are asked to confirm before the application is deleted.