门禁设备重启接口文档
一、接口名称
重启门禁设备
二、接口描述
该接口用于远程重启指定的门禁设备，适用于设备异常时进行远程维护。
三、接口路径
http://ip:port/iot/api/accessControl.restartAccessControlDoor
四、请求方法
POST
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token，通过登录接口获取 |
| app-id | 是 | String | 应用ID，系统dev账户分配 |
| transaction-id | 是 | String | 请求流水号，格式：1000000000+YYYYMMDDhhmmss+6位序列 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间，格式：YYYYMMDDhhmmss |
六、请求参数
6.1 请求体（JSON格式）
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| machineId | 是 | String | 门禁设备ID |
| communityId | 是 | String | 小区ID |
七、返回值
7.1 成功响应
{
"code": "0",
"msg": "成功",
"data": null
}
7.2 失败响应
{
"code": "1",
"msg": "开门失败",
"data": null
}
八、示例请求
POST /iot/api/accessControl.restartAccessControlDoor HTTP/1.1
Host: localhost:8080
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
app-id: 1001
transaction-id: 100000000020231015143000000001
sign: 5a8f7d3e2b1c9d0f6e5a4b3c2d1e0f9
req-time: 20231015143000
Content-Type: application/json
{
"machineId": "AC001",
"communityId": "CM001"
}
九、示例响应
成功响应
{
"code": "0",
"msg": "成功",
"data": null
}
失败响应
{
"code": "1",
"msg": "开门失败",
"data": null
}
十、业务逻辑说明
- 参数校验：检查
machineId和communityId是否为空。 - 用户验证：根据
userId查询用户信息，确保用户存在。 - 门禁设备查询：根据
machineId和communityId查询门禁设备信息。 - 协议验证：检查门禁设备对应的硬件协议是否存在。
- 执行重启：调用对应的硬件厂商协议实现类，执行门禁设备重启操作。
- 返回结果：根据执行结果返回成功或失败信息。
十一、注意事项
- 该接口需要用户认证，确保调用方具有操作权限。
machineId和communityId必须正确匹配，否则会返回门禁不存在的错误。- 如果门禁设备对应的硬件协议未实现，会返回协议不存在的错误。
这份文档符合 RESTful API 规范，并涵盖了请求方法、参数、返回值、示例及业务逻辑说明。