接口列表
本节包含指纹门锁相关接口,这些接口只支持萤石联网指纹门锁,购买门锁。
接口列表如下:
序号 | 接口功能 | 描述 |
---|---|---|
1 | 启动指纹锁验证 | 启动指纹锁的本地验证,验证通过,方可调用添加设备接口来添加设备 |
2 | 获取指纹锁用户列表 | 获取指纹锁用户列表 |
3 | 分页获取开门记录 | 分页获取开门记录 |
启动指纹锁验证
接口功能
该接口用于启动指纹锁的本地验证,指纹锁设备直接调用添加设备接口会返回错误.调用该接口启用本地验证(本地验证需要操作设备), 再轮询调用添加设备接口来关联指纹锁,这个流程需要在120S内完成。
请求地址
https://open.ys7.com/api/lapp/keylock/local/verify
请求方式
POST
子账户token请求所需最小权限
"Permission":"Config"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/keylock/local/verify HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
- 返回数据
{
"code": "200",
"msg": "操作成功"
}
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | 请求成功 |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken过期或异常 | |
10004 | 用户不存在 | |
10005 | appKey异常 | |
20007 | 设备不在线 | |
20014 | deviceSerial不合法 | |
20605 | 其他用户正在认证中 | |
20609 | 设备响应超时,门锁通信故障或者电量不足,请重试. | |
49999 | 数据异常 |
获取指纹锁用户列表
接口功能
该接口用于获取指纹锁上注册的用户列表
请求地址
https://open.ys7.com/api/lapp/keylock/user/list
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
- HTTP请求报文
POST /api/lapp/keylock/user/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
- 返回数据
{
"data": [
{
"lockUserIndex": "27",
"lockUserName": "阿姨",
"lockUserType":"0",
"fingerCount": 10,
"pwdCount": 0,
"cardCount": 0,
"expiredEnable": 0,
"beginTime": 1457420564508,
"endTime": 1457420564508,
"lockType": 1
}
],
"code": "200",
"msg": "操作成功!"
}
- 返回参数说明
参数名称 | 类型 | 描述 |
---|---|---|
lockUserIndex | Integer | 唯一索引ID |
lockUserName | String | 用户名 |
lockUserType | Integer | 锁用户类型(0:主用户,1:非主用户) |
pwdCount | Integer | 开锁数字密码数量 |
cardCount | Integer | 开锁卡数量 |
fingerCount | Integer | 开锁指纹数量 |
expiredEnable | Integer | 0为永久有效,1位非永久 |
beginTime | Long | 账户有效期开始时间,时间格式为1457420564508,精确到毫秒 |
endTime | Long | 账户有效期结束时间,时间格式为1457420564508,精确到毫秒 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken过期或异常 | |
10004 | 用户不存在 | |
10005 | appKey异常 | |
20002 | 设备不存在 | 设备序列号输入有误或者设备未被添加 |
20007 | 设备不在线 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | |
20609 | 设备响应超时,门锁通信故障或者电量不足,请重试. | |
49999 | 数据异常 | 接口调用异常 |
分页获取开门记录
接口功能
该接口用于分页获取指纹锁所在门的开门记录
请求地址
https://open.ys7.com/api/lapp/keylock/open/list
请求方式
POST
子账户token请求所需最小权限
"Permission":"Get"
"Resource":"dev:序列号"
请求参数
参数名 | 类型 | 描述 | 是否必选 |
---|---|---|---|
accessToken | String | 授权过程获取的access_token | Y |
deviceSerial | String | 萤石云设备序列号,存在英文字母的设备序列号,字母需为大写 | Y |
pageStart | int | 分页起始页,从0开始 | N |
pageSize | int | 分页大小,默认为10,最大为50 | N |
- HTTP请求报文
POST /api/lapp/keylock/open/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded
accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&pageStart=0&pageSize=2
- 返回数据
{
"data": [
{
"lockUserName": "老公",
"openType": 1,
"openTime":1457420564508
},
{
"lockUserName": "老公",
"openType": 0,
"openTime":1457420564508
}
],
"code": "200",
"msg": "操作成功"
}
- 返回字段
key | 类型 | 备注 |
---|---|---|
lockUserName | String | 用户名 |
openType | Integer | 开锁方式(0-指纹 1-密码 2-卡) |
openTime | Long | 开锁时间,时间格式为1457420564508,精确到毫秒 |
- 返回码
返回码 | 返回消息 | 描述 |
---|---|---|
200 | 操作成功 | |
10001 | 参数错误 | 参数为空或格式不正确 |
10002 | accessToken过期或异常 | |
10004 | 用户不存在 | |
10005 | appKey异常 | |
20002 | 设备不存在 | 设备序列号输入有误或者设备未被添加 |
20007 | 设备不在线 | |
20014 | deviceSerial不合法 | |
20018 | 该用户不拥有该设备 | |
49999 | 数据异常 | 接口调用异常 |