Overview
An Authorization Token is a piece of data created by the server and contains information to identify a particular User and Authorization Token validity.
The token will contain the User's information and a special token code that the User can use to pass API data to the server instead of directly passing a username and password.
Contents
- Before You Begin
- Add an Authorization Token
- Edit an Authorization Token
- Delete an Authorization Token
Before You Begin
Authorization Tokens are required for all API actions such as Lead Insert, Call Log Update, Lead Recording search, and many others.
To learn more about API and how it works, see What is an API and How Do I Use it?
To learn more about Convoso's API options, see API Menu Options Documentation.
Add an Authorization Token
1.) Click the API main menu.
2.) Click the Authorization Tokens menu option.
The Manage Authorization Token page will open.
3.) Click the Add Authorization Token button.
The Add Token window will open.
4.) Enter a unique name for this Authorization Token.
5.) Configure the Authorization Token's Access Control List.
Check the box in the Access column for each API section you intend to use this token.
- Scroll down and click the box for Check All to give the Authorization Token access to all API sections.
6.) Click the Create button.
7.) Click the Close button.
Edit an Authorization Token
1.) Open the Manage Authorization Tokens page.
2.) Click the Name of the Token to open the settings.
The Edit Token window will open.
3.) Reconfigure the Token's settings as needed.
- (A) Name: Edit the Name used to identify this Authentication Token.
- (B) Access: Check and uncheck boxes granting access to the API sections.
4.) Click the Apply Changes button.
Delete an Authorization Token
1.) Open the Manage Authorization Tokens page.
2.) Click the Action gearwheel drop-down.
3.) Click the Delete option.
A Confirmation window will open.
4.) Click Delete to continue.
A Success window will open.
5.) Click the Close button.