Auth

The Shift API uses an API key and secret for authentication. When you make requests to the Shift API you include your credentials in the header of your HTTP request using the x-key and x-secret headers respectively. To request an API key and secret, please contact [email protected].

Authentication Example

curl --request GET \
  --url https://api.shift.io/v3/me \
  --header 'accept: application/json' \
  --header 'x-key: YOUR_API_KEY' \
  --header 'x-secret: YOUR_API_SECRET'

Your Credentials and You

Your API credentials are yours and are tied to your user. Consequently, all of the transactions that occur using your API key and secret are being done on your behalf. All logs, events, and analytics recorded in the Shift platform will be tied to you.

🚧

Store These Credentials Securely

The API key and secret are your API credentials. Using them you can access ALL of your resources through the API. Store them securely and never transmit them over insecure transports.