Token-based Authentication

The vzaar API uses token-based authentication. This requires client_id and auth_token key-value pairs which you will need to send with each API request.

Generating API tokens

vzaar API tokens cannot be generated via the API. To manage your API tokens you need to login to

Each token consists of a client_id and an auth_token.

Authenticating API requests

Authentication credentials can be sent in two different ways and as long as you provide valid credentials your request will be authenticated successfully.

Request headers (preferred)

  • X-Client-Id
  • X-Auth-Token

Query string parameters (accepted)

  • client_id
  • auth_token