API Requests

All APIs should operate using HTTPS (Secure HTTP using TLS 1.2 or higher).

The appropriate transmission method (POST, PUT, GET) are specified in the description of the individual endpoints later in this document.

The base URL for all APIs is “/v3”.

All request and response data is in JSON format.

Header

Description

Accept

Should be "application/json".

Content-Type

Should be "application/json".

X-PUBLISHABLE-KEY

A customer's publishable api key. This is required for non authenticated calls.

X-CUSTOMER-ID

Customer id. This is required for authenticated calls.

Authorization

The token type and access token values separated by a space.

{
  "X-PUBLISHABLE-KEY": "9d56cd0a8fd84ba88a6a2209",
  "Accept": "application/json",
  "Content-Type": "application/json"
}
{
  "Authorization": "Bearer 4e81e490877d45eca2a403c1",
  "X-CUSTOMER-ID": "09b06ca057d6435bbdef67cf",
  "Accept": "application/json",
  "Content-Type": "application/json"
}