1. 接口使用流程
1.1. 通行业务
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 新建员工、访客、重点人员 | 批量添加人员 | 添加人员需要底库的时候通过上传人员图片进行上传。 | 无 |
| 2 | 新建员工组、访客组、重点人员组 | 批量添加组 | 无 | |
| 3 | 添加员工到员工组、访客到访客组、重点人员到重点人员组 | 编辑组内人员 | 这个接口只会保留最后一次调用的personUuid，所以如果是新加人到组的话，需要先查询一遍已经存在的person | 无 |
| 4 | 添加设备， 分成两大类 | 添加设备 | 变更 | |
| 1. 非面板机和门禁控制器 | 添加设备 | 变更 | ||
| 2. 面板机和门禁控制器 | 发现设备列表 | 1. 先在设备上注册 2. 调用发现设备列表接口获取注册的设备 3. 调用添加设备接口添加设备 |
变更 | |
| 5 | 添加设备通道为门禁点 | 添加点位 | 部分设备的通道会自动加为门禁点， 类型如下： 1. 智能面板机 2. 门禁控制器 |
变更 |
| 6 | 添加通行时间 | 时间计划管理 | 变更 | |
| 7 | 添加门禁权限 | 门禁权限管理 | 时间计划通过时间计划列表查询出来 | 变更 |
| 运行....产生记录..... | 无 | |||
| 8 | 查看通行记录 | 分页查询通行记录 | 变更 |
1.2. 考勤业务
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 新建员工 | 批量添加人员 | 无 | |
| 2 | 新建员工组 | 批量添加组 | 无 | |
| 3 | 添加员工到员工组 | 编辑组内人员 | 这个接口只会保留最后一次调用的personUuid，所以如果是新加人到组的话，需要先查询一遍已经存在的person | 无 |
| 4 | 添加设备， 分成两大类： | 添加设备 | 变更 | |
| 1. 非面板机和门禁控制器 | 添加设备 | 变更 | ||
| 2. 面板机和门禁控制器 | 发现设备列表 | 1. 先在设备上注册 2. 调用发现设备列表接口获取注册的设备 3. 调用添加设备接口添加设备 |
变更 | |
| 5 | 添加设备通道为门禁点 | 添加点位 | 部分设备的通道会自动加为门禁点， 类型如下： 1. 智能面板机 2. 门禁控制器 |
变更 |
| 6 | 添加通行时间 | 时间计划管理 | 变更 | |
| 7 | 添加门禁权限 | 添加通行权限 | 变更 | |
| 8 | 添加考勤点 | 批量添加考勤点 | 变更 | |
| 9 | 添加班次 | 添加班次 | 变更 | |
| 10 | 对人员进行排班 | 添加排班 | 无 | |
| 运行....产生考勤记录.... | 无 | |||
| 11 | 查看报表 | 个人考勤报表统计 | 无 |
1.3. 智能布控
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 在边缘设备如B4H进行智能分析布控 | 通道类型可选择周界、行为、物品、安监、明厨亮灶等 | 无 | |
| 2 | 云上产生智能布控信息 | 启用状态可以控制云上是否接收记录 | 无 | |
| 3 | 产生记录 | 无 | ||
| 4 | 查看智能布控记录 | 智能布控 | 无 | |
| 5 | 查询分析记录 | 分析记录 | 无 |
1.4. 人数统计
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 分析源新增人数统计布控 | 分析源新增人数统计布控 | 无 | |
| 2 | 人数统计分析源组管理 | 人数统计分析源组 | 无 | |
| 3 | 分析源组新增人数统计布控 | * 分析源组新增人数统计布控 | 进行分析源组布控之前必须新建分析源组 | 无 |
| 4 | 查看布控列表查询 | 布控列表查询 | 无 | |
| 5 | 查看人数统计记录 | 人数统计记录 | 无 | |
| 6 | 查看人数统计报警记录 | 人数统计报警记录 | 无 |
1.5. 通行记录回调
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 客户自行开发接受数据的接口 | 例如：http://xxx 或者 https://xxx |
无 | |
| 2 | 在一脸通配置接口添加识别记录回调地址 | 一脸通配置保存 | { "identifyRecordCallbackUrl": " http://xxx"} 或者 { "identifyRecordCallbackUrl": " https://xxx"} |
无 |
| 3 | 用户接受到的数据类型 | 参看通行记录回调部分 | 变更 |
1.6. 考勤记录回调
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 客户自行开发接受数据的接口 | 例如：http://xxx 或者 https://xxx |
无 | |
| 2 | 在一脸通配置接口添加考勤回调地址 | /v1/api/sys/config/saveAFaceConfig | { "attendanceRecordCallbackUrl": " http://xxx"} 或者 { "attendanceRecordCallbackUrl": " https://xxx"} |
无 |
| 3 | 用户接受到的数据类型 | 参看"考勤记录管理"-"考勤记录回调数据结构”部分 | 无 |
1.7. 业务数据推送
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 订阅业务数据 | 业务数据记录订阅 | 订阅类型字典取值范围变更，详见订阅类型 | |
| 2 | 业务数据产生。。。 | 无 | ||
| 3 | 订阅地址接收到数据 | 数据格式参考： 智能分析记录推送 通行记录推送 人数统计推送 考勤数据推送 |
无 |
1.8. 事件记录数据推送
| 序号 | 步骤 | 接口 | 备注 | 变更 |
|---|---|---|---|---|
| 1 | 订阅事件记录数据 | 事件记录订阅 | 订阅的事件类型获取，详见事件类型接口 | 新增 |
| 2 | 事件记录产生。。。 | 无 | ||
| 3 | 订阅地址接收到数据 | 数据格式参考： 事件记录推送 |
新增 |