Authentication

Generate API Key

All requests to the Tines REST API require authentication.

From the Tines navigation menu, select "API keys".

Navigation

On the API Keys page you can view all of the API keys you have access to or create a new key.

Tines has two types of API keys:

  • Personal API keys are linked to your user account, and have access to all items that you do. Operations performed using one of these keys will be recorded as being performed by you. Only you have access to create and delete your personal keys.
  • Tenant API keys are linked to separate service account users, and have full Owner access to the entire tenant. Operations performed using one of these keys will be recorded as being performed by the associated service account user. Tenant Owners have access to create and delete all tenant keys.

To create a new key, select "+ Add API key".

AddKey

Enter a recognizable name for the key, e.g.: the application or service name that will leverage the key, and click "Save" to create the key. The secret for this key won't be shown again after you click "Done", so be sure to copy it beforehand.

Using an API Key

Each request sent to the REST API must be authenticated using an API key, included in the X-User-Token header.

For example:

curl -X GET https://<<META.tenant.domain>>/api/v1/events/ \
  -H 'content-type: application/json' \
  -H 'x-user-token: <<CREDENTIAL.tines_api_key>>'

Bearer/Token Authentication

Our API now includes support for Bearer/Token Authentication. To authenticate using this method, simply include your API token in the Authorization header of your requests, prefixed with "Bearer" and a single space.

For example:

curl -X GET https://<<META.tenant.domain>>/api/v1/events/ \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Was this helpful?