文档中心

样机算子部署列表

API功能简要说明

接口整体说明

无特殊说明，如下2个HTTP请求头域为必填：

Content-Type: application/json //无特殊说明，都是json类型。 Content-Length: xxxx // 内容长度

下文将讲述的接口列表总体分为这几类：

设备管理接口：用于添加视频设备、设置抽帧频率、查询视频设备自身和绑定技能相关的详细信息、以及进行设备的删除。

技能管理接口：用于查询技能列表、将技能与视频设备进行绑定、以及删除绑定关系。

事件管理接口：用于查询视频智能分析的事件列表和订阅异常事件。

人脸库管理接口：1：N识别时，用于向人脸库中添加、删除人脸。

AI识别接口：用于AI识别。

人脸库接口相关解释如下：

人脸库管理要完成1：N识别，首先需要构建一个人脸库，用于存放所有人脸特征，人脸库结构如下：

人脸库、用户、用户下的人脸层级关系如下所示：

|- 用户组（group_id）default
      |- 用户01（uid）
         |- 人脸1（faceid-1）
|- 人脸2（faceid-2）
      |- 用户02（uid）
         |- 人脸（faceid）
   ....

关于人脸库的设置限制

①每个人脸库下，有一个默认用户组default；

②用户组（group）default下，可添加多个user_id；

③每个用户（user_id）现阶段支持注册多张人脸。

API列表

API功能使用步骤

设备管理、技能管理、时间管理三类API的使用步骤整体上可分为三步：

添加摄像头、绑定AI技能、查询/获取识别事件。

具体参考如下：

1）调用“添加视频设备”接口添加设备，建议等待10s再执行后续操作。

2）后续分场景操作如下（注：（）内的API为按需可选API）：

场景1：绑定技能，获取视频智能分析的异常事件（现阶段异常事件规则提前预置）：（查询视频设备列表）——>（查询技能列表）——>技能绑定到设备新建视频分析流——>订阅异常事件，推送异常事件。

场景2：绑定技能，按需绑定和删除多个技能，并获取异常事件（现阶段异常事件规则提前预置）：（查询视频设备列表）——>(查询技能列表)——>技能1绑定到设备新建视频分析流——>技能2绑定到设备新建视频分析流——>技能3绑定到设备新建视频分析——>技能4绑定到设备新建视频分析流——>订阅异常事件，推送异常事件。

注：在视频设备和技能绑定后，可按需使用查询视频设备详情获取视频设备的视频流的信息、设备配置的抽帧频率、设备绑定的技能信息等。

3）通过“删除绑定技能和视频分析流”删除特定的技能分析流。

4）通过“删除视频设备”删除特定设备。

人脸库管理相关接口使用步骤

新增用户（可添加多张人脸，建议人脸总数量为3，1张正脸，2张侧脸）-->查询用户人脸列表-->删除用户人脸（可选）

API字段格式说明

所有POST请求都是JSON格式的body。

如果上一个字段是JSON对象，下一个字段出现+xxx这样的参数名称，表示xxx是JSON的key。如果上一个字段是JSON数组，下一个字段是+xxx，表示xxx是JSON数组的每一项的key。如果出现++xxx，表示这个xxx是其前面第一个+yyy字段的子字段。+的个数表明层级，+个数相同表明从json字段深度上看，字段是相同深度的。

API调用方式说明

该章节的每个接口的完整调用地址由IP：端口+接口URL拼接而成。

默认端口为：81，协议为https。

AI识别接口的端口为7999，协议为http。

API调用时权限认证说明

目前，只有"设备管理和技能管理API接口"需要进行认证，其他接口可直接调用。权限认证需要首先调用用户登录接口，获取登录token（token获取方式参考用户登录API接口），然后在后续调用"设备管理和技能管理API接口"时在请求头中携带该请求头(Authorization)：

例如：
curl -X GET --header "Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyTmFtZSI6ImFkbWluIiwiZXhwIjoxNjY1NTA3MDUwfQ

.-RTto3RhQnY2yjafd-uruXvd9jQlzKV62TFA9kseJ7E" -L https://192.168.1.3:81/console/api/v1/ai/query