门锁服务API

更新时间：2020-03-13 10:13:55

  • 操作锁以锁完成配网绑定为前置条件，否做接口会报781错误码，标识无权访问设备。

  • 密码索引编号用来实现一把锁支持多个密码，需要业务方自己来维护编号。静态密码和动态密码索引编号相互对立。

    静态密码

创建静态密码

为指定的密码索引创建静态密码

密码（可选）要求是六位数字，否则添加失败

/home/paas/lock/staticpassword/create
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
password String 否 明文密码，格式为6位数字，如不传，则按照物模型中定义自动生成密码
ruleData String 否 业务规则，格式为JSON
具体定义参考：格式定义

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息
data String 明文密码

错误码

返回值 信息 描述
62600 create static password err 创建静态密码失败

更新静态密码

更新指定密码索引对应的静态密码

明文传入正确的旧密码，新密码格式要求为6位数字，否则添加失败

/home/paas/lock/staticpassword/update
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
oldPassword String 是 旧密码（明文）
newPassword String 是 新密码（明文）
密码为6位数字，否则更新会失败
ruleData String 否 业务规则，格式为JSON
具体定义参考：格式定义

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息
data String 明文新密码

错误码

返回值 信息 描述
62601 update static password err 更新静态密码失败

获取静态密码

根据设备id和密码索引进行静态密码查询，以明文方式返回密码值

/home/paas/lock/staticpassword/get
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息
data String 明文密码

错误码

返回值 信息 描述
62602 get static password err 获取静态密码失败

发送静态密码给用户APP

根据设备id和密码索引进行静态密码查询，并通过APP push的方式发送到APP

APP要求用户必须在线

/home/paas/lock/staticpassword/push
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
target JSONObject 是 被通知人身份,具体定义参考：操作人

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息

错误码

返回值 信息 描述
62602 get static password err 获取静态密码失败

更新静态密码规则

更新指定密码索引对应的静态密码规则，可用于静态密码临时锁定等业务场景

/home/paas/lock/staticpassword/rule/update
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
ruleData String 是 业务规则，格式为JSON，如果非JSON格式，会报错
具体定义参考：格式定义

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息

错误码

返回值 信息 描述
62603 update static password rule err 更新静态密码规则失败
62608 ruleData can not empty and must be json ruleData为必填项且格式为JSON

动态密码

更新动态规则

更新指定密码索引的动态密码规则

/home/paas/lock/dynamicpassword/rule/update
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
ruleData String 是 业务规则，格式为JSON，如果非JSON格式，会报错
具体定义参考：格式定义

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息
data String 明文密码

错误码

返回值 信息 描述
62604 update dynamic password rule err 更新动态密码规则失败

获取动态密码

根据指定密码索引查询动态密码，以明文返回

/home/paas/lock/dynamicpassword/get
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
stopSize Integer 否 动态密码步长，步长范围为3分钟~30分钟，传入空时为缺省值3分钟，参数单位：秒

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息
data String 明文密码

错误码

返回值 信息 描述
62605 get dynamic password err 获取动态密码失败

发送动态密码给用户APP

根据指定密码索引查询动态密码，并通过APP push的方式发送到APP

APP要求用户必须在线

/home/paas/lock/dynamicpassword/push
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id
passwordIndex Integer 是 密码索引编号,起始值为1
stopSize Integer 否 动态密码步长，步长范围为3分钟~30分钟，传入空时为缺省值3分钟，参数单位：秒
target JSONObject 是 被通知人身份,具体定义参考：操作人

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息

错误码

返回值 信息 描述
62605 get dynamic password err 获取动态密码失败

锁

锁的锁定

锁定指定设备，支持幂等操作

/home/paas/lock/lock
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息

错误码

返回值 信息 描述
62606 lock lock err 锁定门锁失败

锁的解锁

解锁指定设备，支持幂等操作

/home/paas/lock/unlock
  • 当前版本 1.0.0

入参

字段 类型 是否必传 备注
operator JSONObject 否 当前操作人,具体定义参考：操作人
iotId String 是 设备id

出参

字段 类型 备注
code Integer 200标识成功，其他参见“错误码表”
message String 提示信息

错误码

返回值 信息 描述
62607 unlock lock err 解锁门锁失败

密码业务规则定义

ruleData为json串，具体字段如下：

字段名 类型 用途 说明
status Integer 通用 是否开启，1：开启，0：禁用；
拿不到值默认为开启
startTime Long 静态密码 密码生效时间，单位为秒
拿不到值默认为立即生效
endTime Long 静态密码 密码失效时间，单位为秒
拿不到值默认为没用失效时间
useMax Integer 静态密码 使用次数限制
不设置或者为0表示不做限制
optStepSize Integer 动态密码 动态密码的步长（秒），有效值 300 -1800, optStepSize 设置 0时，使用默认的步长3分钟

实例：
{
"status":1,
"startTime":1541387187,
"endTime":1541387687,
"useMax":1000,
"optStepSize":300
}

results matching ""

    No results matching ""