[TOC=2]
>[danger] 注意事项
> * 请求地址另外给出
> * 以下接口完整地址: 请求地址/api/login
> * 除登录接口外,调用其他接口需要在请求头部携带 cookie 。 键名为登录接口返回的 session_key 字段。键值为登录接口返回的 session_value
## 登录
~~~[api]
post:/api/login
*string:username=测试#账号
*string:password=123456#密码
*string:udid=123456#登录标识,用于区分登录的电脑设备,需要每个设备唯一生成,便于区分
<<<
<<<
success
{
"code": 0,
"data": {
"id": 3,
"nickname": "测试",
"name": "测试",
"avatar": "",
"gender": "secret",
"last_login_time": "2019-05-08 16:13:10",
"session_key": "PHPSESSID",
"session_value": "pahnbupgqvt0mlt0hh03e7imff"
}
}
<<<
explain
id // 用户标识
nickname // 用户昵称
name // 用户姓名
avatar // 头像地址(暂未使用)
gender // 性别(暂未使用)
last_login_time // 最近登录时间
session_key // 登录状态,其他接口需要
session_value // 登录状态,其他接口需要
<<<
error
{
"code": -1,
"msg": "账户不存在"
}
~~~
>[danger] 密码需要通过 sha256 之后提交
## 获取型号列表
~~~[api]
get:/api/device_info
<<<
<<<
success
{
"code": 0,
"data": {
"list": [
{
"id": 8,
"name": "优家6901-xy电采暖2.0",
"code_name": "KD5P601",
"sn": "746015",
"firmware": [
"http://cn.ikelink.com/w1_fw/user1.2048.new.3V2_9.bin__IKECIN_TASK_KD5P1",
"http://cn.ikelink.com/w1_fw/user2.2048.new.3V2_9.bin__IKECIN_TASK_KD5P1"
]
},
]
}
}
<<<
explain
id // 型号标识
name // 型号名称
code_name // 项目代号
sn // 序列号开始标识
firmware // 固件地址,没有则为空
<<<
error
{
"code": -1,
"msg": ""
}
~~~
## 获取最后可用号段
~~~[api]
get:/api/last_sn
*int:id=0#上面型号列表的 id
<<<
<<<
success
{
"code": 0,
"data": {
"sn": "870100000000"
}
}
<<<
explain
sn // 可申请的开始序列号
<<<
error
{
"code": -1,
"msg": "该选项不存在"
}
~~~
## 发起申请
~~~[api]
post:/api/save
*string:sn=870100000000#上面接口返回的 sn
*int:num=1#申请数量
*int:device_id=87#获取最后号段选的 id
<<<
<<<
success
{
"code": 0,
"data": {
"start_sn": "870100000033", // 开始号段
"end_sn": "870100000033" // 结束号段
}
}
<<<
explain
start_sn // 申请的开始序列号
end_sn // 申请的结束序列号
<<<
error
{
"code": -1,
"msg": "最少申请 1 个"
}
~~~
## 固件下载
通过型号列表返回的 firmware 字段内的地址进行下载