API access tokens
- XCALLY Knowledge (Unlicensed)
ON THIS PAGE
- 1 API access tokens
- 1.1 Data Frame
- 1.2 View/Edit
- 1.2.1 Details
- 1.2.2 Permissions
- 1.2.3 Callbacks
- 1.2.4 Log
- 1.2.5 Delete
- 1.3 The Excel file Download
API access tokens
The administrator can create all the Tokens he deems appropriate, allowing him/her to decide, depending on the supplier who will have access and the visibility of the data.
The API are useful to connect witiop with external sources.
Please check the API documentation that you can easily download from this section of the Witiop platform.
Data Frame, which covers the number of conversations viewed by the administrator
View/Edit: to view, edit, log or delete the API
Create New API access token
Download Excel file (with all the information in the bracket)
See the Download Excel file section at the End of this page for further information)
For a more in depth analysis of what the admin can do in this section:
Data Frame
By clicking on the Bar the following "curtain" will be opened
from which you can select the number of visible API access token to review, ranging from 10 to 100.
View/Edit
allow the admin to view, edit, log or delete the API.
the API access token section is made up of: Details, Permissions and Callbacks.
Details
Please, check the API documentation provided in the section on Witiop. You can download the file by clicking on here. (see the screenshot below)
To Save the settings remember to press on
Save the changes (remember to press on save when you are done)
Token
Name
Activation date
Expiration date
Activation and Expiration date
The option gives the possibility to select an activation as well as an expiration date.
You can schedule the date by selecting it on the calendar:
Permissions
This section provides an overview of the authorized action, when the API token is used for an external software.
They are needed to authenticate the request.
To Save the settings remember to press on
On/Off option to Read conversations
On/Off option to Read locations
On/Off option to Data export
On/Off option to Send chat messages
On/Off option to Read customers
On/Off option to Write locations
On/Off option to Read template messages
On/Off option to Send template messages
On/Off option to Write customers .
On/Off option to Stats
On/Off option for ApiAccessTokenController.ApiPerm_SetConversationStatus.en-US
Callbacks
An external system can be notified by Witiop when specific events occur.
From the Callbacks section, you can specify the endpoint to which Witiop will send the notification for each specific event: new conversation, incoming message and change in messages status.
Save the changes (remember to press on save when you are done)
New Conversation: Insert here the URL to which Witiop will send a notification when conversations are created in WitiOp (when a customer without an existing conversation sends a message).
New Message: Insert here the URL to which Witiop will send a notification when incoming messages are received.
Message reports: Insert here the URL to which Witiop will send a notification when the status of a message change.
The notification format is already set and you can find further information in the API Documentation ( click the button here in the API access tokens section).
Here there are some examples of notification format:
To Save the settings remember to press on
Log
The Log section contains the detailed log files for all API requests.
Delete
Click on
to go back to the previous feature or
to eliminate the user from the skill.
The Excel file Download
This feature allows to translate all the information related to the API access tokens in an Excel file.
Click on the icon and you will see the following bracket on the top right end of your screen
Open the file and you will have all the information you need in an Excel, easy to share to subjects/departments that do not use the WitiOp platform.
This is valid for all the previous sections