Authentication

Generate API Key

All requests to the Tines REST API require authentication.

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

Navigation

In this dialog you can create a Personal API key, or a Tenant API key:

  • 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.

Keys

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 the API key and corresponding email address. To do so, include the following HTTP Headers with each request:

  • X-User-Token
  • X-User-Email

Note: For all cloud tenants and self hosted tenants using v13+, the X-User-Email header is no longer required

For example:

curl -X GET https://<<META.tenant.domain>>/api/v1/events/ \
  -H 'content-type: application/json' \
  -H 'x-user-email: alice@example.com' \
  -H 'x-user-token: sdfj23jsdfkj3cou0'
Was this helpful?