接口说明:
- 指纹下发
- 指纹下发结果通过回调地址推送给第三方
- 房间封房状态不能指纹下发
1.指纹采集仪读取指纹
2.门锁绑定网关,门锁和网关都需要支持指纹下发
3.指纹下发结果通过hxjGatewaySendKeyResultPush推送给第三方
业务能力:
- openSmartAddFingerPrintKey
本地服务器版本:
- V1.4.5
Content-Version:
- 1.0
参数:
参数名 | 层级 | 类型 | 条件 | 描述 | 备注 |
---|---|---|---|---|---|
lockCode | 1 | String | 必填 | 门锁号 | 可通过房间列表查看 |
customerName | 1 | String | 必填 | 房客名称 | -- |
copyCheckIn | 1 | int | 必填 | 复制入住 | 本地服务器V1.4.5版本: 0 不复制入住,开始时间取推送过来入住的当前时间,且对房间做退房逻辑 1 复制入住,存在房客入住以房客最早开始时间为准 本地服务器V1.5.0版本: 0 退房后入住 先将对应房源内的所有房客退房(删除授权)再入住(执行当前的新授权),取入参开始时间作为本次入住授权的起始时间(时间精度为小时) 1 立即入住 不删除对应房源内的原有授权,以已入住房客授权的开始时间作为本次入住授权的开始时间,如对应房源内没有已入住的房客,则取当前时间作为本次入住授权的开始时间(时间精度为小时) 2 其他时间入住 不删除对应房源内的原有授权,取入参开始时间作为本次入住授权的起始时间(可以为未来时间,时间精度为小时) 备注: 房间门锁开启顶替功能,如果入住时间触发其他授权顶替,服务器则会有异常提示,第三方需要调整入住时间。 如若该门锁号为门禁时,只能选1和2。 房间开启顶替的情况下,该接口只能选0进行入住。 |
idType | 1 | int | 可选 | 证件类型 | 1身份证 2护照 9其他 |
idNumber | 1 | String | 可选 | 证件号 | 最大支持100个字符 |
beginTime | 1 | long | 必填 | 开始时间 | 时间戳,单位秒 |
endTime | 1 | long | 必填 | 结束时间 | 时间戳,单位秒 |
fingerPrint | 1 | String | 可选 | 指纹特征 | 本地服务器V1.5.1版本及之后: fingerPrint和fingerPrintSign二者必填其一 获取方式: (1)第三方对接指纹采集仪,获取指纹特征 (2)发卡器录入指纹成功,推送发卡器按压指纹推送通知(hxjUploadFingerPrintNumPush)获取 |
fingerPrintSign | 1 | String | 可选 | 指纹标识 | 本地服务器V1.5.1版本新增字段: fingerPrint和fingerPrintSign二者必填其一 获取方式: 发卡器录入指纹成功,推送发卡器按压指纹推送通知(hxjUploadFingerPrintNumPush)获取 |
请求示例
{
"tokenId": "aFqJ9GbjlmX0LHZosmciPH3Ewt4S53Fdt/AX7/to/I8IDaYsFkk1cIkz5Ez2Y/PvhDDKWppSuXv1QLcPyLjF+g==",
"method": "openSmartAddFingerPrintKey",
"data": {
"lockCode": "1.2.201A",
"customerName":"zzy",
"copyCheckIn":0,
"idType":1,
"idNumber":"1231231",
"beginTime":1602165958,
"endTime":1608965958,
"fingerPrint":"qweqweqwwetewtwertwrtwaaaaaaa="
}
}
响应示例
{
"msgId": 77568002,
"resultCode": 0,
"reason": "",
"method": "openSmartAddFingerPrintKey",
"data": {
"checkInId": "h0JYf4V93p4=",
"checkInName": "zzy",
"beginTime": 1602165600,
"endTime": 1608965958,
"idType": 1,
"idNumber": "1231231"
"state":3
}
}
响应参数说明
参数名 | 层级 | 类型 | 条件 | 描述 | 备注 |
---|---|---|---|---|---|
checkInId | 1 | String | 必填 | 入住ID | -- |
checkInName | 1 | String | 必填 | 用户姓名 | -- |
idType | 1 | int | 可选 | 证件类型 | 1身份证 2护照 9其他 |
idNumber | 1 | String | 可选 | 证件号 | -- |
beginTime | 1 | int | 必填 | 开始时间 | 时间戳:单位秒 |
endTime | 1 | int | 必填 | 结束时间 | 时间戳:单位秒 |
state | 1 | int | 必填 | 状态 | 1 已入住 3 待下发入住 |
异常码
异常码 | 异常描述 |
---|---|
500001 | 参数异常 |
500201 | 网关不存在 |
500204 | 门锁不支持该功能 |
500207 | 门锁未绑定网关 |
500300 | 房间不存在 |
500504 | 不支持该功能 |
500508 | PMS入住不允许直接退房,请前往PMS页面操作 |