Skip to main content

REST API authentication and headers

With each API call to Varicent Incentives, you must set request headers, including an API key.

The REST API calls are authenticated through an API key. To obtain an API key in Varicent Incentives:

  1. In the admin client toolbar, click the User options icon User icon, and click User options.

  2. Click Create API key, and note your API key.

    Note

    Keep your API key in a safe place, as it will only be shown once.

With each API call, you must set the following three request headers including the API key:

Table 89. REST API headers

Request header

Description

Authorization

Set to Bearer API key.

For example, Authorization: Bearer API key

Model

Set to the model to perform the action on.

Content-Type

Set to application/json.



You can access the Varicent Incentives REST API through any network-capable language, such as C# and Python, or with tools, such as Postman or Curl.