User Guide

Extended API Interface Return Codes

The extended API returns this structure:


            json
            
            
{
    "code": 0,
    "data": {
        "result": null,
        "error": null
    }
}

code is the status of the request itself:

Description	Code
Success	0
Invalid API KEY: the `AccessKey` does not exist or is disabled; or a wrong `secret_key` in direct verification	1
Invalid signature	2
Nonce error: the `nonce` is not greater than the previous one, or differs from server time by more than 1 hour	3
Invalid method: the method does not exist, is not public, or this API KEY has no permission for it	4
Invalid arguments: `args` is not valid JSON, or the call failed	5
Internal error	6
The request's source IP is not in this API KEY's IP whitelist	7

code 0 only means the request was accepted. The method's result is in data.result; when the method fails, data.error holds the error message (null on success). For example, with the wrong number of arguments:


            json
            
            
{
    "code": 0,
    "data": {
        "result": null,
        "error": "Params number mismatch for StopRobot: expected 1, got 0"
    }
}