### 海康威视iVMS-8700平台SDKV2.6 HTTP-OpenAPI使用说明书
#### 概述
本文档旨在为第三方应用提供详细的指导，使其能够顺利地调用iVMS-8700平台的SDK HTTP-OpenAPI接口。通过本文档，读者将了解到如何正确地使用这些接口，包括安全策略、HTTP连接请求的具体细节以及各种开放接口的功能介绍。
#### 安全策略和HTTP连接请求
##### 安全策略
为了确保系统的安全性和数据的完整性，iVMS-8700平台采用了多种安全措施：
1. **身份验证**：通过分配唯一的`appkey`和相应的`secret`给每个第三方应用，以此作为身份验证的基础。
2. **Token生成规则**：生成一个动态的`token`来保障每次请求的安全性，防止参数被恶意篡改。
3. **时间戳验证**：使用`time`时间戳来限制请求的有效时间范围，从而避免恶意的重复请求。
##### 约定参数说明
- **appkey**：这是iVMS-8700平台为第三方应用提供的唯一标识符，用于与平台上注册的对应`secret`值进行签名认证。
- **time**：表示第三方应用发起请求时的时间戳，通常采用UNIX时间戳（单位通常是秒或毫秒）。
- **token**：一个根据特定算法生成的字符串，用于验证请求的合法性，防止请求被篡改。
##### Token认证方式
1. **Token生成规则**：平台会根据`appkey`、`secret`以及当前时间戳等信息按照一定的加密算法生成一个动态的`token`。
2. **请求验证**：在每次HTTP请求时，都需要包含这个`token`，服务器端会根据相同的规则重新计算`token`并与客户端提交的`token`进行比对，如果一致，则认为请求有效。
#### 第三方接入配置
第三方应用接入前，需要在iVMS-8700平台上进行注册，并获取相应的`appkey`和`secret`。注册完成后，第三方应用即可按照文档的要求构建HTTP请求。
#### 开放接口定义
##### 接口列表
iVMS-8700平台提供了丰富的开放接口，涵盖了基础应用、视频、门禁、停车场等多个领域：
1. **基础应用**
- 用户管理
- 权限管理
- 设备管理
2. **视频**
- 实时预览
- 录像回放
- 视频分析
3. **门禁**
- 设备管理
- 访问控制
- 事件查询
4. **停车场**
- 出入口管理
- 车辆识别
- 收费管理
5. **可视对讲**
- 设备管理
- 对讲服务
- 事件记录
6. **访客**
- 预约管理
- 登记处理
- 数据统计
7. **考勤**
- 打卡管理
- 班次设置
- 统计报表
8. **入侵报警**
- 报警管理
- 布撤防操作
- 日志查询
9. **梯控**
- 控制管理
- 状态查询
- 事件记录
10. **巡查**
- 巡查任务
- 结果上报
- 统计分析
每个接口都详细定义了其功能、输入参数、输出参数以及示例代码，帮助开发者更好地理解和使用。
#### 接口定义
每类接口都有详细的定义，例如：
1. **基础应用**接口包括用户管理和权限管理等功能，支持创建、更新、删除用户信息及设置用户的访问权限。
2. **视频**接口可以进行实时视频流的获取、历史录像的查询和下载等操作。
3. **门禁**接口用于门禁设备的管理和访问控制，包括添加、修改、删除门禁设备及其权限设置。
#### 参考示例
文档还提供了大量的示例代码，覆盖了所有接口的主要功能，方便开发者快速上手。这些示例代码通常使用常见的编程语言编写，如Python、Java等。
#### 附录
附录部分提供了各种类型的编码定义，如设备类型编码、事件类型码等，帮助开发者更好地理解接口参数的意义。
本文档不仅详细介绍了iVMS-8700平台的HTTP-OpenAPI接口使用方法，还深入探讨了安全性、接口设计等方面的内容，是第三方开发者接入该平台的重要参考资料。
- 1
- 2
前往页