Request Headers

X-ApiKey

You must supply your API Key with every request that does not require an access token. It can be passed to the API using this request header or the query-string.

X-ApiKey: {your-api-key}

X-ApiSecret

The API Secret is used to gain access to our API for applications that you cannot prove the origin of. You must supply your API Secret for every request that comes from a server or app. The secret can call the API from every origin so it is extremely important that it is not compromised.

Never send your secret in code that is exposed to the client. This applies to all methods of code that are not secured like client-side code (such as HTML or JavaScript) or native apps (such as iOS, Android or Windows desktop apps) that could be decompiled.

We recommend that API Secrets should only be used directly from your app's servers in order to provide the best security. For native apps, we suggest that the app communicates with your own server and the server then makes the API requests to our API using the Secret.

If your API Secret is compromised, you should reset it immediately. Open your Project and click the Renew button next to API Secret. You will have to change the Secret in your code.

X-ApiSecret: {your-api-secret}

Authorization

Some endpoints require the use of an access token and not an API-Key. The documentation of the endpoint will state that. To get an access token please read the Access tokens page. You can use it by sending an Authorization header in the request.

Authorization: bearer {access_token}

X-CaseType

Be default the API will return the JSON models in PascalCase. You can request a different one by adding X-CaseType in the header. Possible values are lowercase, uppercase and camelcase.

X-CaseType: lowercase

Content-Type

When using HTTP POST you need to specify the Content-Type of your request as application/json.

Content-Type: application/json

Accept

The API will respond in JSON or XML, depending on the specified Accept header. Possible values are application/json and application/xml.

Accept: application/xml