Varicent Incentive Compensation Management Documentation

REST API authentication and headers

With each API call to Varicent Incentive Compensation Management (ICM), 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 Incentive Compensation Management (ICM):

  1. In the admin client toolbar, click the User options icon user-icon.svg, 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 83. 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 Incentive Compensation Management (ICM) REST API through any network-capable language, such as C# and Python, or with tools, such as Postman or Curl.