The Evergage REST API provides access to read and update data at several levels. This API can be used to create and update users and accounts within Evergage. It can also receive behavioral data from offline systems, as well as historical transaction data. Finally, catalog data, such as products and content can be upserted.


This section details the Evergage REST API.




Types of Evergage APIs

Evergage includes batch and single item calls for all types of data and can receive JSON and CSV formatted content for most types of data. Batch formatted data is always sent via the HTTP POST method and must be accompanied by an API Token, which can be used by adding the "_at" parameter to URL of the API.

Authorizing the REST API

The Evergage REST API utilizes API tokens to authorize all data changes.

  1. Log into the Evergage platform as an Administrator
  2. Navigate to Security -> API Tokens 
  3. Click Create Token
  4. Select the options needed
  5. Click OK
  6. Once created, the API token will be available for use with your API calls. To use the API token, add a parameter named "_at" to the request with the value of the token which you can access by double clicking the token on the API Tokens list screen.