呤云科技访客二维码接口详解

需积分: 10 3 下载量 99 浏览量 更新于2024-09-09 收藏 349KB PDF 举报
"呤云科技设备访客接口文档" 这篇文档主要介绍了呤云科技提供的与访客二维码相关的API接口,这些接口允许开发者集成到自己的系统中,以便实现访客的二维码访客管理功能。以下是各接口的详细说明: 1、下发访客二维码接口(SetVisitorPassport) - 用途:用于生成访客的二维码,该二维码可在指定时间内有效,并且有特定的使用次数。 - 参数说明: - ownerId:业主ID,必须填写。 - visitorName:访客姓名,必须填写。 - startTime:二维码生效的起始时间,针对在线设备,以毫秒为单位,必须填写。 - endTime:二维码失效的结束时间,针对在线设备,以毫秒为单位,必须填写。 - effecNumber:二维码的有效使用次数,必须填写。 - keys:SDK开门使用的密钥,必须填写。 - visitorTelephone:访客电话,可选。 - visitorGender:访客性别,0表示女性,1表示男性,可选。 2、删除访客二维码接口(DelVisitorPassport) - 作用:用于撤销已生成的访客二维码,使其失效。 - 参数说明:通常包含业主ID(ownerId)和访客二维码ID(visitorPassportId)等,用于指定要删除的二维码。 3、查询访客二维码接口(GetVisitorPassport) - 作用:查询已生成的访客二维码信息,如有效期、使用次数等。 - 参数说明:可能包括业主ID(ownerId)和其他用于定位二维码的信息。 4、业主开门接口(UserOpenDoor) - 作用:允许业主通过API远程控制门禁设备,为访客开启门禁。 - 参数说明:通常包含业主ID(ownerId)、设备ID(deviceId)以及其他可能需要的身份验证信息。 在使用这些接口时,首先需要调用查询设备服务器地址接口(queryServerAddr)获取服务器的addr和openToken,然后将这些信息与具体的接口名称拼接,形成完整的请求URL进行HTTP请求。 这些接口的使用涉及到设备访问控制、访客管理以及业主权限的管理,对于实现智能化物业管理或门禁系统的开发具有重要作用。通过这些接口,可以实现对访客进出权限的精细化管理,提高安全性和便利性。同时,这些接口也提供了丰富的参数设置,可以根据实际需求定制访客二维码的生效时间和使用次数。