请求约定
请求时的必要参数
Http Headers 需要提交的参数
参数名 | 类型 | 说明 |
---|---|---|
X-API-KEY | string | 应用的API KEY |
X-SIGN | string | 签名,具体签名见后面的签名方式 |
X-SIGN-TIME | string | 当前客户端时间戳 |
X-TOKEN | string | 用户登录后获取的令牌,没有可不传递 |
签名方式
签名 = sha1(请求体内容 + 应用的API Secret + 时间戳)
返回约定
除去服务器意外场景,API只要请求成功,就会按http code 200返回,请根据返回中的code判断结果:
统一Code
下面code为用于标识常见的错误场景用于前期判断(如未登录):
Code | 原因 |
---|---|
0 | 成功 |
1000 | 没有变化 |
-4000 | 用户未登录 |
-4001 | 没有找到上传的文件 |
-5000 | 提交的文字长度异常 |
-5010 | 有冲突的数据 |
-8000 | 请求次数过多,请稍后再试 |
-9400 | API KEY错误,可能被吊销或异常 |
-9405 | 系统维护中 |
-9999 | 异常错误 |