Common Calling Convention
Parameters#
We recommend that you use POST method to pass the parameters. You should always include the following two parameters in every call:key: The API key you got from the sales manager.
signature: The signature for the parameters, it is generated with the key & secret and the other parameter values.
Signature Generation Algorithm#
For example, we have three parameters to pass:and the key & secret got from the sales manager:Then generate the signature by 3 steps:1.
Get a concatenated string with the key and the other parameter values which are sorted by their corresponding names: 19mailMYKEYJohn Smith; (Keep the whitespaces)
2.
Append a character of '@' and the secret to the string: 19mailMYKEYJohn Smith@MYSECRET;
3.
Calculate the signature with MD5 algo: signature=MD5("19mailMYKEYJohn Smith@MYSECRET");
ATTENTION: Do NOT place the secret into the parameters.Response#
Success#
{
"result": "success",
"data": { ... } or [ ... ] or any value
}
Error#
{
"result": "error",
"messages": [ "message1" ]
}
Modified at 2026-03-11 08:46:10