Authentication

Headers

X-API-Key

Include the "X-API-Key" header in your API requests, and ensure it contains your API key.

X-API-Sign

Authenticated requests must be signed using the "X-API-Sign" header. The signature is generated with your private key, encoded payload, and the request method, following the HMAC-SHA512 algorithm:

Generating the signature

HMAC-SHA512 of (Request Method + SHA256(Request Body)) and base64-decoded API Key secret

Signature Calculation Example:

For a POST request, you might calculate the signature as follows:

  1. Request Method: POST

  2. POST data: SHA256 hash of the JSON payload. Example of payload: "{"name":"John"}"

  3. Concatenate the Request Method and SHA256 hash. Example: "POST" + "{"name":"John"}"

  4. HMAC-SHA512: Apply HMAC-SHA512 using the concatenated string and the base64-decoded API Key secret

Code examples

Last updated