Authentication

Authentication Method

All requests must be made over HTTPS and will be authenticated over standard HTTP basic authentication.

API Authentication Key

Authentication requires a x-api-key. When these values are requested in console/terminal, programming libraries, SDKs, or even here in our docs, use the following values for x-api-key:

Key	Value
x-api-key	{API_KEY}

The API key must be kept secret. They should not be in your client-side code or checked into your application's code.

Example Requests

Ping Request

curl --request GET \
    -u x-api-key:API_KEY \
    --url {Sanbox_URL}/api/ping

Current API Key

Current API Key Request

curl --request GET \
  -u x-api-key:API_KEY \ 
  --url {Sanbox_URL}/api/api_keys/current