REST API Access

DV2000/DV4 provides a REST API that applications can use to query certain types of information and manage certain services on the DV2000/DV4 system.

Requirements

Use of the REST API requires the following prerequisites:

User Accounts and Authentication

The REST API Access connector is used to manage the user accounts that are allowed to access the API.  Each account has a user name and an authorization key, both of which are used when a client queries the API.

For more on using the API, refer to the documentation found at link.duvoice.com/developers.

Add a User

To add a user account, enter a unique user name in the User name box and click Add.  The name will be added to a new row in the table.  The AuthKey field will be auto-generated when you click Apply or OK to save your changes.

Delete a User

To delete a user (or multiple users), check the box nest to each user name you wish to delete, then click the Delete button.  You will be prompted to verify the deletion.

Click Yes to delete the user or No to cancel the operation.

Copy to Clipboard

Click the Copy to Clipboard button will copy the AuthKey field to the Windows clipboard so you can paste it into your application's code or configuration.  The AuthKey is used to encrypt the authorization phrase that the API requires for most queries.  For more information on the API and the authorization phrase, please refer to the online documentation for the REST Interface at support.duvoice.com.