用户指南 | 发明者量化

扩展API接口返回码

扩展API接口的每个响应都是下面的JSON结构：code表示请求本身是否成功，方法的结果在data中。


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

code是请求本身的状态码：

描述	代码
执行成功	0
错误的API KEY：`AccessKey`不存在或已禁用；直接验证时`secret_key`不正确	1
错误的签名	2
Nonce错误：`nonce`不大于上次请求的值，或与服务器时间相差超过1小时	3
方法不正确：方法不存在、不对外开放，或这把API KEY没有该方法的权限	4
参数不正确：`args`不是合法的JSON，或请求无法分发（例如`method`与`args`的个数不一致）	5
方法执行出错（例如没有操作该实盘的权限、实盘正忙、超出可运行的实盘数量），见下文	6
请求来源IP不在这把API KEY的IP白名单内	7

code为0时，方法的结果在data.result中。参数个数或类型与方法不符时，code仍为0，data.result为null，data.error为错误信息（成功时为null）。例如参数个数不对：


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

方法执行过程中出错时，返回code为6，错误信息在顶层error字段，data为null。例如操作不属于自己的实盘：


            json
            
            
{
    "code": 6,
    "error": "Access Denied",
    "data": null
}