API Keys

API Keys

Overview

Required roles

Create an API Key

Edit an API Key

Overview

SIP Caller allows you to define API Keys to integrate it with external systems. You can define as many API Keys as you need, assigning an expiration and roles. An external system can use the REST API provided by SIP Caller, authenticating with the API Key Token generated as described below.

Required roles

In order to create or edit an API Key, the user needs one of the following roles:

• Administrator

In order to view an API Key, the user needs one of the following roles:

• Account Reader

Create an API Key

To create an API Key:

1. Go to “Settings” > “API Keys”, and then click “Create”.

2. Specify a name for the API Key.
3. Select an expiration. Please note that this can’t be extended once the API Key has been created.
4. Enable the roles you want to grant to the applications that will use this API Key. Please note that this can’t be changed once the API Key has been created.
5. Click “Save” to create the API Key.

6. A dialog will be shown, containing the Token for the API Key just created. Copy the value and save it in a safe place. This token will not be shown again, and it can’t be recovered, as SIP Caller will not store it. If you lose it, you will need to create another API Key.

Edit an API Key

To edit an API Key:

1. Go to “Settings” > “API Keys”, and then click on the API Key that you want to edit.

2. At this point, you can only edit the name, and visualize the creation and expiration date and time, and the roles assigned to the API Key. If you need to change other values, you will need to create another API Key.

Delete an API Key

When you need to revoke the access of an application to SIP Caller, you will need to delete the API Key. To do that:

1. Go to “Settings” > “API Keys”, and then select the API Key that you want to delete.
2. Click the Delete button and confirm the operation.