Accounts API

The API tab allows the current administrator to manage the parameters for integrating the account with external applications, using the available API interfaces.

The page is divided into 3 sections:

Call center

This section is used for setting up a connector that will link Accolades with an external CRM, available on the call center agent computer. The connector will run inside the agent browser (Agent menu from the Call center module), inside a hidden iframe.

The section contains two properties:

External CRM API connector
sets up the connector that will be autoloaded into the agent interface (can be undefined, one of the available connectors from the server or a connector personalized for this account);
Custom API CRM connector
this property displays the custom connector loaded for this account.

More information about setting up the connectors is available in the API chapter of this documentation, the External CRM section.

API REST

Accolades allows for external applications to send commands to the server, using HTTPS. This section displays the elements needed for configuring the API.

Status
the status for this module (active: the server allows API requests, inactive: the server does not allow API requests);
Username
the username (same as the account code) used for authenticating the requests;
Password
A symbolic text, composed of 6 stars, indicating that a password is required to authenticate a HTTPS request.

More information about setting up the connectors is available in the API chapter of this documentation, the API REST section.

Configuration

Accolades can save up to 2000 characters for each account.

When an application is connected to the server, using an API, Accolades will send the text, on request. It is recommended to use existing standards for saving data (JSON, XML etc.). Accolades will not perform any validation on the text, it will be saved and sent as plain text, in a raw format.

More info about the options for reading this data, using the available API interfaces can be found on the API section of this documentation.