人员授权门禁接口文档
一、接口名称
人员授权门禁
二、接口描述
用于外系统人员授权门禁功能，将指定人员授权给指定的门禁设备
三、接口路径
http://{ip}:{port}/iot/api/accessControlFace.saveAccessControlFace
四、请求方法
POST
五、请求头
| 参数名称 |
必填 |
类型 |
描述 |
| Authorization |
是 |
String |
用户认证token Base token 通过登录接口获取token |
| app-id |
是 |
String |
应用ID 系统dev账户分配 |
| transaction-id |
是 |
String |
请求流水号 不能重复 1000000000+YYYYMMDDhhmmss+6位序列 |
| sign |
是 |
String |
签名 |
| req-time |
是 |
String |
请求时间 YYYYMMDDhhmmss |
六、请求参数
6.1 请求体参数
| 参数名称 |
必填 |
类型 |
格式 |
描述 |
| communityId |
是 |
String |
30位字符串 |
小区ID |
| ownerId |
是 |
String |
64位字符串 |
人员编号 |
| machineIds |
是 |
Array |
字符串数组 |
设备编号列表 |
| startDate |
是 |
String |
日期格式 |
授权开始日期 |
| endDate |
是 |
String |
日期格式 |
授权结束日期 |
七、返回值
7.1 返回值结构
| 参数名称 |
类型 |
描述 |
| code |
int |
返回码，0表示成功，其他表示失败 |
| msg |
String |
返回信息 |
八、业务逻辑说明
- 验证请求参数是否完整
- 检查人员是否已经授权过指定的门禁设备
- 查询人员详细信息
- 为每个门禁设备创建授权记录
- 保存授权信息到数据库
九、数据库操作
- 查询人员信息
- 查询人员照片信息
- 保存门禁授权记录
十、示例请求
{
"machineIds": ["123123", "123124"],
"ownerId": "22",
"communityId": "2022081539020475",
"startDate": "2023-08-15",
"endDate": "2023-12-31"
}
十一、示例响应
{
"code": 0,
"msg": "成功"
}
十二、错误码说明
| 错误码 |
描述 |
| 0 |
成功 |
| 其他 |
失败，具体错误信息见msg字段 |
十三、注意事项
- 同一人员不能重复授权同一门禁设备
- 授权时间范围必须有效
- 人员必须存在于系统中
