Skip to end of metadata
Go to start of metadata

Authentication Service

Before you can make calls to any of Xandr's API services or reports, you must use your username and password to get an authorization token. The token remains active for 2 hours, during which you do not need to re-authenticate. This page walks you through the authentication process.

You will have to work with the Xandr platform member you are partnering  with to set up authentication credentials (i.e., a username and password).

On This Page

Step 1. Create a JSON-formatted file including your username and password

Below, we have used the cat command to show the output of the file.

Step 2. POST the file to the authentication service

The request returns a token that remains valid for the 2 hours following your most recent call to the API. We suggest using "-b cookies -c cookies" in the POST request to store the token in a cookie.

Step 3. Use the token when making calls to API services and reports

In the example below, we call the Member Service and authenticate using the token stored in the cookie.

Alternately, if you didn't store the token in a cookie, you can put the token in the request header as "Authorization: TOKEN".

Authentication Frequency

After authenticating, your token remains valid for 2 hours. You do not need to re-authenticate within this time. If you do re-authenticate, please note the following limitation: the API permits you to authenticate successfully 10 times per 5-minute period. Any subsequent authentication attempts within those 5 minutes will result in an error.

It is best practice to listen for the "NOAUTH" error_id in your call responses and re-authenticate only after receiving it.

  • No labels