快速上手

阔道致力于提供给程序员愉悦的开发体验。

登录获取会话

配置钥匙流程

钥匙定义

本系统使用钥匙定义，来对密码和开门卡进行管理，一个钥匙可以关联多个设备，可以标识持有人名称，有效期限。另外，钥匙还有多种状态，当某一个钥匙可操作时，则状态为有效。当某一个钥匙到了使用期限时，则状态为到期。当操作员主动撤销某个钥匙时，则状态为撤销。

某个钥匙关联多个设备的作用在于当某个钥匙需要同时可操作多个门锁时，可进行灵活配置，常用于门禁公共门与房门门锁配合、门锁公共门与房门门锁配合、某一楼层或某一楼栋管理员权限、办公室门与宿舍门同时操作等场景。

当钥匙有效期结束时，系统会自动撤销该钥匙，此时该钥匙的状态为到期，并且撤销人为 system。

最简单的钥匙操作

login(取得 sessionid) --> setKey(添加钥匙并判断是否全部生效) --> logout(注销 sessionid)

微信、App 扫码开门流程

远程操作需知

本系统的提供远程开门指令，该调用需要指定操作目标的设备 ID，所以需要实现微信或 App 扫码开门的时候，需要二维码的数据可唯一定位指定设备（即微信或 App 扫码后可以知道当前是要操作哪个设备）。

微信与 App 扫码开门流程

微信

• 微信扫码（获得指定设备 ID）--> login（获得 sessionid）--> executeUnlock（执行开门）--> logout（注销 sessionid)

App

• App 扫码（获得指定设备 ID）--> login（获得 sessionid）--> executeUnlock（执行开门）--> logout（注销 sessionid)