开门系统API接口文档1

本文档主要介绍了一个名为"开门系统"的API接口，它主要用于实现远程开门、获取设备信息以及发卡/密码管理等功能。这个API接口设计用于网络协议交互，允许第三方应用与该系统进行数据交换，以实现智能化的门禁控制。 首先，基础的接口调用需要通过`appid`和`secret`来获取调用凭证（Token）。`appid`是第三方接入码，标识了应用的身份；`secret`是凭证密钥，用于验证调用者的合法性。调用`/v1/token`接口，采用GET方法，提供这两个参数，返回JSON格式的结果，包含状态码（code）、过期时间（expired_in）和调用接口所需的Token。 接下来，开门接口（/v1/open-door）允许通过指定的房间号（roomnu）、请求ID（requestid）、开门方式（method）和Token来开门。开门方式包括扫码（1）、密码（2）和门禁开门（3）。此接口同样采用GET方法，返回的状态码（code）用于判断操作是否成功。 2.1.3接口（/v1/get-roominfo）用于获取设备ID对应的酒店和房间信息。通过设备ID（deviceid）和Token发起GET请求，返回JSON数据，包括房间号（roomnu）、appid（关联酒店的信息）和状态码（code）。 2.1.4接口允许发卡或设置密码。通过`appid`、房间号（roomnu）、卡ID/密码（keyvalue）、类型（keytype，区分发卡或密码）、到期时间（expire-date）和请求ID（requestid），以及Token来实现。卡ID/密码的类型由keytype决定，0代表发卡，1代表设置密码。返回的状态码（code）表示操作结果。 2.1.5接口则用于取消发卡或密码功能，参数与2.1.4接口相似，但其作用是撤销之前设置的卡ID或密码。 接口的版本更新记录显示了接口功能的逐步完善和优化，如增加新的开门方式、添加新接口以支持更复杂的操作，以及对原有接口的调整，如增加requestid字段以追踪请求，或增加新的返回状态以提供更详细的反馈信息。 总的来说，这个开门系统API接口提供了全面的门禁控制功能，涵盖了身份验证、设备信息查询、门禁操作以及卡片和密码管理等多个方面，为构建智能门禁解决方案提供了坚实的基础。开发者可以通过这些接口，结合自己的应用程序，实现与门禁系统的无缝集成，创建安全、便捷的访问控制环境。