Skip to main content

Authentication

  1. Using a Request Header

  2. Using OAuth2.0 (Roadmap)

1. Request Header​

Obtain a token​

Api tokens can be created or revoked for both the sandbox and production environments from your dashboard (coming soon). Up to 2 tokens can be active at a time, allowing them to be rotated without downtime.

Please reach out for support via your Account manager if you are unable to create a token

Using Your Token​

Your token should be included in an 'Shift-Auth-Token' header on the request.

Not supplying a token, or using an invalid token will result in an error. "Full Authentication required."

Test your authentication​

A "health" endpoint is provided for you to verify your working token, the following curl request can be used.

curl --location 'https://sandbox.shiftapi.online/api/health' \
--header 'SHIFT-AUTH-TOKEN: <Your-Token>'

URL: {baseUrl}/api/health

Method: GET

Response:

"OK"