api 说明
api 的地址为 stock.kikt.top/api
请求规则
格式
请求格式统一为 json
编码格式为 utf-8
所有请求均使用POST
method
path 严格区分大小写
url
url 的自分类 path 包含两级(不含 api)
例: https://stock.kikt.top/api/user/login
示例中 user 为一级 path, login 为二级 path
请求头
请求头不影响内容识别,但是通常情况下请使用application/json
除登录接口为,其余所有接口必须包含三个参数
key | desc |
---|---|
stuid | user id |
stsign | 签名校验 |
sttimestamp | 毫秒级 Unix 时间戳 |
时间戳与服务器时间相差不超过 30 秒
登录接口会返回服务器时间戳字段
加签方式
登录会回返 token 字段
将 uid token 时间戳字段以字符串方式连接
然后使用 sha1Hex 将该字段加签
作为stsign
的值传入
请求参数
一般情况下,请求参数应直接包含在 json 根节点内
如果某个请求不需要参数,请传递{}
,而不是空字符串
所有请求的 value 均为 string 类型, 即使需要的参数是一个数字也请放入双引号内
特殊情况会在 api 接口内说明
对于属性说明而言,不包含非必填字样的均为必填参数
举例:
{
"uid": "11"
}
回包规则
回包统一使用 json 格式, utf8 编码
响应码
正常情况下,响应码应为 200
如不为 200,则说明出错
响应头
响应头中会包含 Content-Type
字段 值为application/json;charset=UTF-8
响应体
响应体为 json 格式
共有参数 code : 逻辑状态码, 200 为成功,其他均为失败 msg: 提示内容, 不是 200 时,会提示失败原因,是 200 时会提示相应的提示内容