Authentication

This section is critical, authentication is REQUIRED for accessing every open APIs.

Create API Key

1. Navigate to CRM Back Office - Settings - Dev Space - Open API Keys Page
2. Create an API Key

Key Authentication

Requesting every API in this documentation requires authentication via the above API key. Please attach the API key as a http header of the request.

Signature

Any POST/PATCH/PUT API that contains a request body will need to sign the request and provide the signature as a HTTP header.

Signature Algorithm

1. Set the request or return data as set M, and sort the parameters of non-empty parameter values in the set M according to the ASCII code of the parameter name from smallest to largest (dictionary order), using the URL key-value pair format (ie key1=value1&key2=value2... ) It is spliced into a string (String A).
2. After the character transferred, splice API Key to obtain the string to be encrypted (StringB), perform SHA-1 operation on StringB, transfer the obtained value as a hexadecimal string, and finally convert all characters of the obtained string to uppercase to obtain the signature.

Sample JavaScript code to obtain the signature

let query = Object.keys(data)
   .sort()
   .reduce((result, key) => result + key + '=' + data[key] + '&', "")
   .slice(0, -1);

let sign = crypto.createHash('sha1').update(query + key).digest('hex').toUpperCase();

query = '&'.join([f"{key}={data[key]}" for key in sorted(data)])

sign = hashlib.sha1((query + key).encode('utf-8')).hexdigest().upper()

Error Codes