API文档目录

编写目的

海康威视智能应用平台 Infovision IoT v1.0.0产品(以下简称平台)是个开放的平台,提供了视频、物联智能大数据等方面的能力开放。基于平台开放的能力,第三方厂家和开发者可快速实现丰富的智能大数据应用。
本文档详细描述了平台开放的API接口、调用方式、使用场景等内容。用户指导开发者基于平台做二次开发。

阅读对象

希望基于平台提供的能力,做应用开发的第三方厂家和开发者。
阅读群体需要具备以下技能,才能很好的理解文档内容。
1:良好的计算机编程能力。掌握java,c++,php等常见的一种或者多种编程语言。
2:对安防知识有一定的认知。理解监控点、云台控制、卡口、名单库、布控报警等专业名称。

环境要求

API接口的对接和联调需要部署海康威视智能应用平台Infovision IoT v1.0.0或更高版本的产品。

更新说明

快速上手

阅读指南

为了能快速得了解平台能提供的API功能,和快速上手,建议按照以下顺序阅读本文档剩余内容:
1. 查阅【术语解释】章节,对文档内会出现的专业术语有个初步认知。
2. 查阅【开放能力总览】章节,对平台提供的能力有初步认识和理解。
3. 阅读【编程引导】章节,通过几个案例的讲解,进一步认识平台提供的能力和能实现的应用效果展示。
4. 确认需要开发的业务需求,并初步给出平台需要提供API能力需求。
5. 阅读【接口规则】章节,掌握API的调用方式。
6. 阅读【API列表】章节,按分类查找API,通过阅读API的描述了解具体功能,挑选需要的API 。
7. 按照API接口定义,编码开发。完成APP应用。

项目对接指南

1. 平台准备

首先,项目上需要部署平台。该平台本身的业务功能正常运行,才有条件提供对应功能的能力给外部使用。

Note:
本文档列举了平台可提供的全部API功能。具体在每个项目上部署的平台,可使用的API接口都不相同(API接口的能力需要平台、前后端设备等多种产品配合完成,项目上的平台可能只具有部分API能力)。需要调用者向我司相关人员询问可使用的API列表。

2. 实际参数调用获取

1:获得项目上平台服务器的IP地址和PORT端口号。
2:从用户平台运管管理人员处获取调用认证所需的AppKey和AppSecret。AppKey和AppSecret为两个字符串,需要妥善保管,一旦泄露,需立即向用户平台运管管理人员申请重置AppSecret,并获得新的AppSecret。

术语解释

术语/缩写 含 义
Infovision IoT 海康威视智能应用平台的英文名称
OpenAPI 对外开放的接口
AppKey/AppSecret 用于API调用的签名认证使用,成对出现,两个字符串。在项目上一般有我司技术支持提供,用于调用本平台提供的OpenAPI。
AK/SK AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。
AMQP AMQP,即Advanced Message Queuing Protocol,高级消息队列协议,是应用层协议的一个开放标准,为面向消息的中间件设计。消息中间件主要用于组件之间的解耦,消息的发送者无需知道消息使用者的存在,反之亦然。 AMQP的主要特征是面向消息、队列、路由(包括点对点和发布/订阅)、可靠性、安全。
RabbitMQ RabbitMQ是一个开源的AMQP实现,服务器端用Erlang语言编写,支持多种客户端,如:Python、Ruby、.NET、Java、JMS、C、PHP、ActionScript、XMPP、STOMP等,支持AJAX。用于在分布式系统中存储转发消息,在易用性、扩展性、高可用性等方面表现不俗。
MQTT MQTT(Message Queuing Telemetry Transport,消息队列遥测传输)是IBM开发的一个即时通讯协议,有可能成为物联网的重要组成部分。
API网关 API Gateway,既平台OpenAPI的直接提供者。平台内部的API通过API网关实现对外发布。调用方通过API网关来访问平台提供的OpenAPI。
云台控制 PTZ控制。在安防监控应用中是pan/tilt/zoom的简写,代表云台全方位(上下、左右)移动及镜头变倍、变焦控制。
RTSP RTSP(Real Time Streaming Protocol),RFC2326,实时流传输协议,是TCP/IP协议体系中的一个应用层协议,由哥伦比亚大学、网景和RealNetworks公司提交的IETF RFC标准
RTMP RTMP是Real Time Messaging Protocol(实时消息传输协议)的首字母缩写。该协议基于TCP,是一个协议族,包括RTMP基本协议及RTMPT/RTMPS/RTMPE等多种变种。RTMP是一种设计用来进行实时数据通信的网络协议,主要用来在Flash/AIR平台和支持RTMP协议的流媒体/交互服务器之间进行音视频和数据通信。支持该协议的软件包括Adobe Media Server/Ultrant Media Server/red5等
HLS HLS (HTTP Live Streaming)是Apple的动态码率自适应技术。主要用于PC和Apple终端的音视频服务。包括一个m3u(8)的索引文件,TS媒体分片文件和key加密串文件。
图像识别 图像识别,是指利用计算机对图像进行处理、分析和理解,以识别各种不同模式的目标和对像的技术。在本文中指识别出人脸、人体、车辆目标的能力。
抓拍库 也指动态库。前端设备实时采集和后端智能服务对实时、历史视频进行智能分析所产生出的人脸、人体、车辆目标存储的数据集合,我们定义为抓拍库。
名单库 也指静态库。在本文中特指人脸名单库。一个人员的基本身份信息和该人员的照片作为一个人员名单,很多个人员名单的集合定义为名单库。可以添加多个名单库。基于名单库,可实现身份确认、布控、查重等应用。