KDays API文档中心

请求约定

请求时的必要参数

Http Headers 需要提交的参数

参数名类型说明
X-API-KEYstring应用的API KEY
X-SIGNstring签名,具体签名见后面的签名方式
X-SIGN-TIMEstring当前客户端时间戳
X-TOKENstring用户登录后获取的令牌,没有可不传递

签名方式

签名 = sha1(请求体内容 + 应用的API Secret + 时间戳)

function sign(string $jsonBody) {
    $sigTime = time();
    $appSecret = "你的API Secret";
    return sha1($jsonBody . $appSecret . $sigTime);
}

返回约定

除去服务器意外场景,API只要请求成功,就会按http code 200返回,请根据返回中的code判断结果:

{
    "code": "返回码 0=成功 其他代表失败或意外情况",
    "msg": "提示信息",
    "data": "返回数据"
}

统一Code

下面code为用于标识常见的错误场景用于前期判断(如未登录):

Code原因
0成功
1000没有变化
-4000用户未登录
-4001没有找到上传的文件
-5000提交的文字长度异常
-5010有冲突的数据
-8000请求次数过多,请稍后再试
-9400API KEY错误,可能被吊销或异常
-9405系统维护中
-9999异常错误

On this page