添加自定义密码

https://api.sciener.com/v3/keyboardPwd/add

向锁里写入一个4-9位的自定义限期密码,自定义密码只支持限期、永久类型,有效期可以精确到分钟,没有像随机密码方案那样必需在24小时内使用的限制和同时间段个数限制。

自定义密码主要有两种写入方式:

(1)通过APP或小程序蓝牙连接锁添加:

开发者可以集成SDK开发自己的App,调用添加密码方法将密码添加到锁里,再调用该接口(addType = 1),将密码同步到云端,方便后续管理。注意必需先通过SDK蓝牙添加后,再调用该接口如果直接调用该接口,生成的密码只在云端,并不存在锁上,无法开锁

(2)通过网关WiFi锁远程添加:

如果锁有连接网关设备,则可以直接调用该接口(addType=2),通过网关WiFi锁把密码添加到锁里。

WiFi锁如果开启了省电模式可以(addType=4)进行异步下发,异步下发相关介绍可以参考:远程开锁-WiFi锁

由于锁本身存储空间有限,最多只能写入250个自定义密码,超过个数限制会返回-3009的错误码,提示空间已满,需要先删除其他的,再添加。

1 HTTP请求方法及示例

2 参数说明

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockIdIntY锁ID,由锁初始化接口生成
keyboardPwdIntY密码
keyboardPwdNameStringN密码名称
keyboardPwdTypeIntN密码类型:2-永久,3-限期,不传默认为3
startDateLongN有效期开始时间(时间戳,单位毫秒),期限密码必传
endDateLongN有效期开始时间(时间戳,单位毫秒),期限密码必传
addTypeIntY添加方式(不传则默认addType = 1):
1-必需先通过SDK蓝牙添加后,再调用该接口如果直接调用该接口,生成的密码只在云端,并不存在锁上,无法开锁!
2-通过网关WiFi锁远程添加,锁必须在线(WiFi锁或有连接网关)则可以传2,直接调用该接口同时添加到锁里和云端;WiFi锁如果开启了省电模式可以传4进行异步下发
3-NB-IoT,如果是NB-IoT锁,则可以传3,通过NB网络写入,需要等NB唤醒才会下发添加指令。
dateLongY当前时间(时间戳,单位毫秒)

3 返回参数及示例

参数类型描述
keyboardPwdIdInt密码ID