密码操作

发时效密码

http 请求方式:POST(请使用 https 协议)https://api.kdware.cn/hapi/v1.1/issueGuestTimeLimitedPasswd

功能简介:用于用生成开门用时效密码。

请求示例

参数说明

{
"sessionid": "d5ecec7a-099d-4114-8d95-a553dc833bb6",
"owner": "test",
"sysID": "10805",
"roomID": "13112",
"endDate": "2019-09-18T12:00:00.000+08:00"
}
参数类型可选说明
sessionidstring必须会话凭证
ownerstring必须持有人名
sysIDstring必须系统 ID
roomIDstring必须门锁的设备 ID,以 10 进制字符串格式表示
endDatestring必须钥匙失效时间。 格式请使用 ISO 8601 时间格式。如:2019-09-18T12:00:00.000+08:00

注意:时效密码的失效时间有以下要求

  • 使用时效密码时,请确定门锁的时候是准确的,如果门锁长时间停电,请使用手机开一次门,手机在开门时会自动完成时间校准动作。
  • 时效密码可使用的时间为起始时间的 23 小时以内。
  • 时效密码的失效时间只能精确到小时。
  • 小于 365 天的有效时长, 失效时间可精确到指令的小时。
  • 超过 365 天的有效时长,失效时间需为起始时间使用相同日和小时, 比如 2019/9/17 12:00 发的密码,失效时间需为 2020/9/17 12:00。
  • 最大时间长度不可超过 8 年。

返回结果

正确时的返回 JSON 数据包如下:

{
"resultCode": 0,
"pinCode": "123456",
"keyID": "123456"
}
参数类型说明
resultCodenumber0 为成功,其它值为失败
pinCodestring新生成的开门密码
keyIDstring操作成功后会返回新创建的钥匙的钥匙 ID

发一次性密码

http 请求方式:POST(请使用 https 协议)https://api.kdware.cn/hapi/v1.1/issueOneShotPasswd

功能简介:用于用生成开门用一次性密码,一次性密码只能在3个小时内开一次门。

请求示例

参数说明

{
"sessionid": "d5ecec7a-099d-4114-8d95-a553dc833bb6",
"owner": "test",
"sysID": "10805",
"roomID": "13112"
}
参数类型可选说明
sessionidstring必须会话凭证
ownerstring必须持有人名
sysIDstring必须系统 ID
roomIDstring必须门锁的设备 ID,以 10 进制字符串格式表示

返回结果

正确时的返回 JSON 数据包如下:

{
"resultCode": 0,
"pinCode": "123456",
"keyID": "123456"
}
参数类型说明
resultCodenumber0 为成功,其它值为失败
pinCodestring新生成的开门密码
keyIDstring操作成功后会返回新创建的钥匙的钥匙 ID