接口列表 - Powered by MinDoc

一、平台工作逻辑

请先查看文档如何注册，注册成功后获得 Host、TenantId、AppSecret 再进行接入。

工作逻辑示意图：

工作逻辑示意图 )

平台接口所有指令都是同步发送到设备，如果设备不在线，就无法接收到指令。

序号	功能	地址	说明
1	回调地址	/api/BluetoothLock/CallbackUri	设置回调地址。如极少变化可不对接，由工作人员代为修改
2	蓝牙锁管理卡	/api/BluetoothLock/CardManage	设置应急卡；`仅限一代锁`
3	网关管理	/api/BluetoothLock/GatewayReboot	重启网关
4	网关-蓝牙锁管理	/api/BluetoothLock/LockList	设置网关与蓝牙锁对应关系
5	蓝牙锁单双卡模式	/api/BluetoothLock/LockMode	设置蓝牙锁单卡、双卡模式
6	主动开锁	/api/BluetoothLock/OpenLock	发送主动开锁指令
7	用户卡片管理	/api/BluetoothLock/UserCardManage	设置二代锁的用户卡片；`仅限二代锁`
8	刷卡开锁回复	/api/BluetoothLock/CardSwipeReply	用户刷卡后，推送到用户端的“刷卡开锁接口”，用户端回复是否允许开锁
9	日志回复	/api/BluetoothLock/LogReply	网关产生日志后，每10秒会推送一次数据到用户端“日志推送”接口，直至用户端调用本接口确认已经收到日志

一代、二代设备的区分：

一代网关编号为 11 开头，一代锁编号为 39 开头
二代网关编号为 21 开头，二代锁编号为 49 开头

当网关不在线时，又想对网关进行设置，可以调用平台的离线接口

无论网关、锁是否在线都可以调用表格中的接口，当网关上线后会开始发送指令并确保指令成功

序号	功能	地址	说明
1	离线应急卡管理	/api/BluetoothLock/CardManageOffline	设置应急卡；`仅限一代锁`
2	离线用户卡片同步	/api/BluetoothLock/UserCardManageOffline	全量更新网关及其蓝牙锁的所有卡片，网关在线后会开始同步
3	离线蓝牙锁管理	/api/BluetoothLock/LockListOffline	设置网关与蓝牙锁对应关系
4	离线蓝牙锁单双卡模式	/api/BluetoothLock/LockModeOffline	设置蓝牙锁单卡、双卡模式

接入平台的用户，需要提供一个接口，以供平台推送设备数据。

假设用户开发的接口地址为：https://an1api.com/callback

当网关、蓝牙锁发生以下状态变化时，平台会推送对应的数据到用户提供的接口地址：

序号	功能	地址	是否需要回复	状态说明
1	刷卡开锁	https://an1api.com/callback?cmd=CardSwipe	`需要回复是否允许开锁`	在蓝牙锁上的刷卡开锁请求
2	日志推送	https://an1api.com/callback?cmd=Log	`需要回复接收成功，否则会重复发送`	一代锁：所有日志信息；二代锁：网关离线后的开锁信息
3	心跳请求	https://an1api.com/callback?cmd=Heartbeat	不需要	网关上的心跳数据，包含网关与锁的信息
4	蓝牙锁状态	https://an1api.com/callback?cmd=LockStatus	不需要	蓝牙锁锁状态发生变化后会推送信息；无需回复
5	蓝牙锁管理卡	https://an1api.com/callback?cmd=CardManage	不需要	一代锁：设置应急卡片的回复
6	网关-蓝牙锁管理	https://an1api.com/callback?cmd=LockList	不需要	设置网关与锁的对应关系后的回复
7	蓝牙锁单双卡模式	https://an1api.com/callback?cmd=LockMode	不需要	设置蓝牙锁的单卡、双卡模式的回复
8	主动开锁	https://an1api.com/callback?cmd=OpenLock	不需要	主动发送开锁指令的回复
9	用户卡片管理	https://an1api.com/callback?cmd=UserCardManage	不需要	二代锁：设置有权限开锁的用户卡片的结果回复；`一代锁不适用`

暂未提供

作者：阮德明创建时间：2025-06-05 16:15
最后编辑：阮德明更新时间：2025-11-17 16:50