添加二维码

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

在云端生成一个"二维码",会返回一个H5链接,打开链接页面,会展示一个二维码,将二维码靠近锁的摄像头,锁扫描到二维码,识别二维码中的信息后开锁。

如果不想使用系统默认的二维码展示页面,可以在添加二维码后,调用获取二维码数据接口获取二维码数据内容,基于内容自己生成二维码图片。

特征值支持自定义二维码的锁可以通过APP蓝牙或者网关直接向锁里添加二维码。

注意:

只有特定型号的锁才支持二维码,不支持二维码的锁调用接口会返回"此锁不支持该功能"的提示。具体可以根据锁的特征值进行判断;随机二维码:特征值第44位;自定义二维码:特征值第108位

 

1 HTTP请求方法及示例

POST, ContentType:application/x-www-form-urlencoded

2 参数说明

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockIdIntY锁ID,由锁初始化接口生成
nameStringN二维码名称,锁管理员给二维码的命名。
typeIntY二维码类型,1-限时、2-永久、4-循环
startDateLongN有效期开始时间(时间戳,单位毫秒)
endDateLongN有效期结束时间(时间戳,单位毫秒)
refreshTimeIntN二维码刷新时间,单位为分钟,不传默认为10,最大1440
cyclicConfigJSONArray StringN循环时间设置,目前只支持每天开始时间和结束时间一样的设置,示例:
[{"weekDay":1, "startTime":480,"endTime":1080},{"weekDay":2, "startTime":480,"endTime":1080}] 表示周一和周二8:00到18:00有效
addTypeIntY随机二维码添加方式:
0-云端方式,不填默认0,从云端生成一个二维码,二维码由云端的算法规则生成,不需要锁连接网关就可以生成。
自定义二维码添加方式:
1-必须先通过SDK蓝牙添加,然后再调用该接口,否则二维码只存在云端,无法开锁!
2-通过网关WiFi锁远程添加,锁必须是WiFi锁或有连接网关,则可以传2,直接调用该接口添加到锁里
qrCodeNumberStringN生成自定义二维码时必须传该参数:
二维码不能大于4294967295同时不能小于65535 ,开发者需要确认二维码编号唯一。 建议:开发者可以直接使用秒级的时间戳
dateLongY当前时间(时间戳,单位毫秒)

cyclicConfig中的参数:

参数类型描述
startTimeInt开始时间,分钟数, 例如 480 代表 8:00
endTimeInt结束时间,分钟数, 例如 1080 代表 18:00
weekDayInt星期:1-7, 1-星期一...7-星期天

3 返回参数及示例

参数类型描述
qrCodeIdInt二维码ID
qrCodeNumberInt二维码号,同一把锁的每个二维码对应一个唯一的二维码号,用于区分开锁日志。
linkInt二维码H5页面链接