宇视科技门禁系统对外接口文档说明-V1.09.20230116
### 宇视科技门禁系统对外接口文档说明-V1.09.20230116
#### 概述
本文档旨在提供宇视科技门禁系统的对外接口规范,帮助开发者更好地理解和使用该系统提供的各项服务。文档详细记录了自初始版本至当前版本的所有修订历史与内容变更,确保用户能够准确掌握最新的接口使用方法。
#### 修订记录概览
- **初始版本**(2019-05-15):完成初稿。
- **人员信息查询接口调整**(2019-10-17):
- 将`Data`结构中的`Num`字段调整为`Total`和`Offset`。
- `PersonInfoList`字段改为`PersonInfo`。
- **时间格式标准化**(2019-10-17):
- 推送消息中的`CurrentTime`和`TerminationTime`字段的数据格式更改为UTC秒值。
- **内容类型标准化**(2019-10-17):
- 记录推送请求报文头中的`Content-Type`字段值更改为`text/plain`。
- **新增功能**(2019-10-17):
- 新增人员库查询接口。
- 新增人员接口,移除多余的时间模板相关字段示例代码和说明。
- **订阅接口改进**(2019-10-29):
- 修改`IPAddress`和`Port`字段的描述,增加“订阅方”的概念。
- 修改推送消息中的`LibMatInfoList`字段描述,将`LibMatchInfoList`结构体名称更改为`CtrlLibMatInfo`。
- **数据类型标准化**(2019-12-24):
- 人员结构中的`TimeTemplateNum`类型更改为`unsigned long`。
- **业务流程优化**(2019-12-24):
- 优化3.2互联网组网下的基本业务流程。
- **健康信息集成**(2020-02-18):
- 在`FaceInfoList`数组中增加体温和口罩相关字段。
- `MatchStatus`字段增加人脸属性异常状态字。
- **时间模板接口**(2020-03-12):
- 新增时间模板信息处理接口。
- **参数优化与添加**(2020-03-16):
- 优化人员新增接口中的`TimeTemplateNum`字段描述。
- 新增`TimeTemplateLIst`数组描述。
- `记录推送消息`中增加设备编码`DeviceCode`字段。
- **匹配状态优化**(2020-03-17):
- 修改`记录推送接口`中`MatchStatus`字段的匹配状态含义。
- **功能增强与调试工具集成**(2020-03-26):
- 更新时间模板相关信息的请求参数示例及相关描述。
- 添加时间模板绑定参数,并指定照片格式要求。
- 调试工具处新增参数示例及Java开发DEMO下载链接。
- **人机交互控制接口**(2020-04-20):
- 新增人机显示控制接口。
- **网络调试工具指南**(2020-09-21):
- 删除重复的网络调试工具章节。
- 新增网络调试工具说明指导。
- 新增postman调试工具说明指导。
- **问题排查指南**(2020-12-28):
- 修改常见对接问题处理中订阅无法获取记录的排查方式。
- **报警布防接口**(2021-06-22):
- 新增报警布防接口。
- **文档质量提升**(2022-06-02):
- 全文错别字校正与格式重新排版。
- 响应报文举例新增`SubResponseCode`字段及描述。
- 删除不再适用的参数要求,调整为必选、可选、条件可选等。
- 新增心跳间隔设置接口。
#### 关键知识点解析
##### 1. 人员信息查询接口
- **字段调整**:在早期版本中,人员信息查询接口的`Data`结构中的`Num`字段被调整为`Total`和`Offset`字段,以提高数据的灵活性和准确性。
- **数据结构变化**:`PersonInfoList`字段被更改为`PersonInfo`字段,以简化数据结构,便于数据处理。
##### 2. 时间格式标准化
- **时间字段标准化**:为了统一时间表示格式,`CurrentTime`和`TerminationTime`字段的数据格式被更改为UTC秒值,这有助于减少因时区差异带来的误差。
##### 3. 内容类型标准化
- **内容类型更改**:记录推送请求报文头中的`Content-Type`字段值更改为`text/plain`,以简化数据传输过程中的编码和解码工作。
##### 4. 订阅接口改进
- **字段描述优化**:针对`IPAddress`和`Port`字段进行了描述上的优化,并引入了“订阅方”的概念,使得订阅机制更加清晰。
- **数据结构优化**:将`LibMatchInfoList`结构体名称更改为`CtrlLibMatInfo`,以避免混淆并提高可读性。
##### 5. 数据类型标准化
- **数据类型调整**:人员结构中的`TimeTemplateNum`类型从原先的类型调整为`unsigned long`,以适应更大的数值范围。
##### 6. 业务流程优化
- **业务流程重构**:对3.2互联网组网下的基本业务流程进行了优化,提高了系统的稳定性和效率。
##### 7. 健康信息集成
- **健康数据集成**:在`FaceInfoList`数组中增加了体温和口罩相关字段,以及`MatchStatus`字段中增加人脸属性异常状态字,提升了安全性。
##### 8. 人机交互控制接口
- **新增接口**:新增的人机显示控制接口进一步增强了系统的交互能力,提供了更多样化的使用场景支持。
##### 9. 报警布防接口
- **安全功能扩展**:新增的报警布防接口丰富了系统的安全防护措施,为用户提供更全面的安全保障。
##### 10. 文档质量提升
- **文档质量改进**:通过全文错别字校正与格式重新排版,提高了文档的可读性和专业性,方便用户查阅和理解。
通过以上知识点的详细介绍,我们可以看到宇视科技门禁系统对外接口文档的不断完善和发展过程,不仅在技术层面进行了持续的优化和升级,还在用户体验方面做出了诸多努力,以满足不同场景下的需求。这对于开发者来说是非常宝贵的资源,可以帮助他们更好地利用宇视科技门禁系统的功能和服务。
访问申明(访问视为同意此申明)
2.部分网络用户分享TXT文件内容为网盘地址有可能会失效或其他任何情况(此类多为视频教程,如发生失效情况【联系客服】自助退回)
3.请多看看评论和内容介绍大数据情况下资源并不能保证每一条都是完美的资源
4.是否访问均为用户自主行为,本站只提供搜索服务不提供技术支持,感谢您的支持