To make calls to an API, you require API credentials which authenticate your request.
Your API credentials consist of:
- your client ID. Your client ID identifies who you are, a bit like a user name.
- your client secret. Your client secret is a password that's generated by Vonage Contact Center.
If you do not already have API credentials, you will need to create them in API Credentials. For information about creating new API credentials, see Creating new API credentials later in this page.
If you already have API credentials and want to reuse these for an additional scope, you can add that scope to your existing credentials. For information about adding a new scope to existing API credentials, see Adding a scope to your existing API credentials later in this page.
Creating new API credentials
Click here to expand...
To create user-level API credentials for your account, perform the following steps:
- Log in to Vonage Contact Center and go to API Credentials (within Account Settings). API Credentials appears. If applicable, go to the Users tab.
Click Create New. Create API Credentials appears. Provide the following information:
| Field | Description |
|---|
Name | A name to identify the credentials later. We recommend that you use a name that describes the credential's intended use. Type a name for the credentials. You can edit this later. |
| Scopes | The scope or scopes that you want these API credentials to work with. In the Scopes list, click to see the available scopes. Click the name of the scope to add it.
Click x alongside the scope name to remove it.
Add as many scopes as you like to your API credentials. See the documentation for individual APIs to see which scopes you will require. You can edit the list of scopes later. |
- Click Create. A Success message appears and your new credentials appear.
Copy and save your client ID and secret; you cannot retrieve them later. You will need your client ID and client secret every time you make a call to authenticate with a Vonage Contact Center API - Click OK. Your new credentials appear—without the secret—in API Credentials.
Adding a scope to your existing API credentials
Click here to expand...
Depending on your license, you can edit different API credentials. As a supervisor user, you can only edit your own user-level credentials; admin users can additionally edit any existing account-level credentials. No one can modify someone else's user-level credentials.
From API Credentials, click to open the API credentials you wish to change.
You can add or remove scopes to or from the API credentials. A new scope might give the credentials access to a different API, or additional access to an already allowed API.
You can also change the name of the API credentials.
When you have finished making changes, click Save API credential.