HomMeeᴿAI

具备对视频监控设备（硬盘录像机或视频监控系统、摄像机）、视频分析设备，新增、配置、删除、查询等操作。

1. 检测是否在线

• 接口功能描述：新增数据源时需要传入告警图片大小、编码格式，需要先通过此接口获取；

• 接口路径：[GET]http://设备IP:9089/ks/stream/attr；

• 请求参数说明；

表. 请求参数

• 请求示例；

表. 请求参数

• 响应参数说明；

• 响应示例。

2. 获取数据源画面

• 接口功能描述：获取数据源画面，绘制检测区域时调用获取；

• 接口路径：[GET]http://设备IP:9089/ks/stream/image；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. onvif

• 接口功能描述：获取数据源信息，如品牌、码流地址等；

• 接口路径：[GET]http://设备IP:9091/ks/source/onvif；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 新增数据源

• 接口功能描述：新增数据源并配置相关算法、检测区域等；

• 接口路径：[POST] http://设备IP:9091/ks/source；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例；

5. 编辑数据源

• 接口功能描述：编辑数据源信息；

• 接口路径：[PUT] http://设备IP:9091/ks/source；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

6. 删除数据源

• 接口功能描述：删除数据源；

• 接口路径：[DELETE] http://设备IP:9091/ks/source；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例；

7. 查询数据源

• 接口功能描述：查询数据源，不传参表示查询所有数据源；

• 接口路径：[GET] http://设备IP:9091/ks/source；

• 请求参数说明；

表. 请求参数

• 响应参数说明；

• 响应示例；

8. 修改数据源排序

• 接口功能描述：修改数据源排序，用于控制界面显示数据源的顺序；

• 接口路径：[PUT] http://设备IP:9091/ks/source/index；

• 请求参数说明；

表. 请求参数

• 响应参数说明；

• 响应示例；

9. 订阅实时视频流

获取视频流播放前端示例代码（点击此处跳转）

• 接口功能描述：订阅实时画面，获取实时画面播放地址；

• 接口路径：[GET] http://设备IP:9089/ks/stream/live/subscribe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例；

10. 取消订阅实时视频流

• 接口功能描述：取消订阅实时画面；

• 调用时机：调用编辑数据源接口之前调用此接口；

• 接口路径：[GET] http://设备IP:9089/ks/stream/live/unsubscribe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例

1. 获取系统参数

• 接口功能描述：获取系统参数；

• 接口路径：[GET] http://设备IP:9091/ks/system/args；

• 请求参数: 无

• 响应参数说明；

表. 请求参数

• 响应示例。

2. 获取远程隧道参数

• 接口功能描述：获取远程隧道参数；

• 接口路径：[GET] http://设备IP:9091/ks/system/tunnel；

• 请求参数: 无

• 响应参数说明；

表. 请求参数

• 响应示例。

1. 告警信息

• 接口功能描述：实时订阅盒子告警；

• topic：ks/sink_local_alert；

• 对应平台位置：【实时画面】右侧【最新告警】模块

• 响应示例。

{
"msg_id": "uuid",
"msg_type": "alert",
"time": "发送时间",
"data": {
	"id": "告警id",
	"alert_time": "时间戳",
	"source_id": "摄像头ID,对应新增摄像头的ID",
	"source_ipv4": "摄像头IP",
	"source_desc": "摄像头描述",
	"alg_name": "算法英文名称",
	"alg_ch_name": "算法中文名称",
	"image": "图片路径，访问需要加上代理http://设备IP:9092/staticdata+图片路径",
	"reserved_data": "人脸告警才有数据",
	"hazard_level": "危害等级",
	"status": "摄像头状态"// 1: 启用，-1：停用
	}
}

{
group:{
	"id": "666825ae5dc58a319bb9c1e8",
	"name": "分组名称",
},
face:[{
	"id": "6594e027522e4bbbcfe12194（唯一ID）",
	"name": "姓名",
	"age": "年龄",
	"sex": "性别",
	"desc": "描述",
	"update_time": "时间戳",
	"lib_image": "底库人脸图片",
	"cap_image": "抓拍人脸图片",
	"conf": "比对置信度"
	}
]}

2. 实时结果

获取实时检测结果可视化代码（点击此处跳转）

• 接口功能描述：实时订阅实时分析结果（播放流时产生MQTT消息）；

• topic： ks/sink_local_result

• 对应平台位置：【实时画面】

• 响应示例。

{
    "msg_id": "uuid",
    "msg_type": "result",
    "time": "2024-01-23 10:25:36.216528",
    "data": {
        "time": "1705976735.391402",
        "hit": false,
        "hazard_level": "", //危险等级
        "source": {
            "id": "摄像头id",
            "ipv4": "摄像头ip",
            "desc": "摄像头描述"
        },
        "alg": {
            "type": "算法类型",
            "name": "算法英文名称",
            "ch_name": "算法中文名称",
        },
        "reserved_data": {
            "bbox": {
                "rectangles": [{
                		//左上角、右下角坐标
                        "xyxy": [680, 198, 1178, 696], 
                        "color": [0, 0, 255], //BGR颜色
                        "conf": 0.91, //置信度
                        "label": "未佩戴安全帽", //标签
                        "ext": {} //扩展字段
                    }
                ] //矩形数组
                "polygons": {
                    "xxxxxx": { //多边形id
                        "name": "离岗检测", //多边形名称
                        "color": [0, 0, 255], //BGR颜色
                        "polygon": [ //顶点坐标
                            [568, 205],
                            [920, 140],
                            [843, 471],
                            [576, 471]
                        ],
                        "ext": {} //扩展字段
                    }
                } //多边形对象
                "lines": {
                    "xxxxxx": { //线段id
                        "name": "线段1", //线段名称
                        //顶点坐标
                        "line": [[680, 198], [1178, 696]], 
                        "color": [0, 0, 255], //BGR颜色
                        "ext": {} //扩展字段
                    }
                } //线段对象
            }
        }
    }
}

3. 上位机服务上下线、网络状态

• 接口功能描述：上位机服务上下线状态、网络状态；

• topic： ks/monitor_local

• 响应示例。

{
       "msg_id": "uuid",
       "msg_type": "server_proxy",
       "time": "发送时间"，
       "data":0 // 0离线  1在线
}

{
       "msg_id": "uuid",
       "msg_type": "network",
       "time": "发送时间"，
       "data": 1 //1：联网  0：未联网
}

1. 添加分组

• 接口功能描述：添加人脸等底库前，先添加分组，使底库能以分组形式管理

• 接口路径：[POST] http://设备IP:9091/ks/group

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 修改分组

• 接口功能描述：修改分组信息；

• 接口路径：[PUT] http://设备IP:9091/ks/group；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. 查询分组

• 接口功能描述：查询分组；

• 接口路径：[GET] http://设备IP:9091/ks/group；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 删除分组

• 接口功能描述：删除分组；

• 接口路径：[DELETE] http://设备IP:9091/ks/group；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

1. 添加人脸库

• 接口功能描述：添加人脸姓名、性别等至底库，最多1000个人脸；

• 接口路径：[POST] http://设备IP:9091/ks/face

• 接口说明：如需上传人脸图片，请参照9.3.8.6修改人脸图像接口。

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 修改人脸库

• 接口功能描述：修改人脸库信息；

• 接口路径：[PUT] http://设备IP:9091/ks/face；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. 查询人脸库

• 接口功能描述：查询人脸（按设备、姓名、外部id、更新时间查询）；

• 接口路径：[GET] http://设备IP:9091/ks/face；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 删除人脸库

• 接口功能描述：删除人脸；

• 接口路径：[DELETE] http://设备IP:9091/ks/face；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

5. 载入底库

• 接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；

• 接口路径：[POST] http://设备IP:9091/ks/face/load；

• 请求参数说明： 无；

• 响应参数说明；

• 响应示例。

6. 添加或修改人脸图像

• 接口功能描述：添加或者修改人脸图像；

• 接口路径：[PUT] http://设备IP:9091/ks/face/image；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

7. 下载模板

• 接口功能描述：下载模板；

• 接口路径：[GET] http://设备IP:9091/ks/face/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

8. 批量导入

• 接口功能描述：批量导入；

• 接口路径：[POST] http://设备IP:9091/ks/face/xlsx；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

9. 批量导出

• 接口功能描述：批量导出人脸底库；

• 接口路径：[GET] http://设备IP:9091/ks/face/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

10. 提取人脸特征

• 接口功能描述：根据传入的人脸图片提取人脸特征；

• 接口路径：[POST] http://设备IP:9091/ks/face/feature；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

1. 添加工服库

• 接口功能描述：添加工服信息至底库，最多1000个工服；

• 接口路径：[POST] http://设备IP:9091/ks/work\_clothes；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 修改工服库

• 接口功能描述：修改工服库信息；

• 接口路径：[PUT] http://设备IP:9091/ks/work\_clothes；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. 查询工服库

• 接口功能描述：查询工服（按设备、名称、外部id、更新时间查询）；

• 接口路径：[GET] http://设备IP:9091/ks/work\_clothes；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 删除工服库

• 接口功能描述：删除工服；

• 接口路径：[DELETE] http://设备IP:9091/ks/work\_clothes；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明

• 响应示例

5. 载入底库

• 接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；

• 接口路径：[POST] http://设备IP:9091/ks/work\_clothes/load；

• 请求参数说明：无；

• 响应参数说明；

• 响应示例。

6. 添加或修改工服图像

• 接口功能描述：添加或者修改工服图像；

• 接口路径：[PUT] http://设备IP:9091/ks/work\_clothes/image；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

7. 下载模板

• 接口功能描述：下载模板；

• 接口路径：[GET] http://设备IP:9091/ks/work\_clothes/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

8. 批量导入

• 接口功能描述：批量导入；

• 接口路径：[POST] http://设备IP:9091/ks/work\_clothes/xlsx；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

9. 批量导出

• 接口功能描述：批量导出工服底库；

• 接口路径：[GET] http://设备IP:9091/ks/work\_clothes/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

1. 添加PPE库

• 接口功能描述：添加PPE信息至底库，添加前判断限制最多1000个PPE信息；

• 接口路径：[POST] http://设备IP:9091/ks/ppe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 修改PPE库

• 接口功能描述：修改PPE信息；

• 接口路径：[PUT] http://设备IP:9091/ks/ppe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. 查询PPE库

• 接口功能描述：查询PPE（按设备、分组、名称、外部id、更新时间查询）；

• 接口路径：[GET] http://设备IP:9091/ks/ppe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 删除PPE库

• 接口功能描述：删除工服；

• 接口路径：[DELETE] http://设备IP:9091/ks/ppe；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明

• 响应示例

5. 载入底库

• 接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；

• 接口路径：[POST] http://设备IP:9091/ks/ppe/load；

• 请求参数说明：无；

• 响应参数说明；

• 响应示例。

6. 添加或修改PPE图像

• 接口功能描述：添加或者修改PPE图像；

• 接口路径：[PUT] http://设备IP:9091/ks/ppe/image；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

7. 下载模板

• 接口功能描述：下载模板；

• 接口路径：[GET] http://设备IP:9091/ks/ppe/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

8. 批量导入

• 接口功能描述：批量导入；

• 接口路径：[POST] http://设备IP:9091/ks/ppe/xlsx；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

9. 批量导出

• 接口功能描述：批量导出ppe底库；

• 接口路径：[GET] http://设备IP:9091/ks/ppe/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

1. 添加开放库

• 接口功能描述：添加开放信息至底库，添加前判断限制最多1000个开放底库；

• 接口路径：[POST] http://设备IP:9091/ks/open\_lib；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 修改开放底库

• 接口功能描述：修改开放底库信息；

• 接口路径：[PUT] http://设备IP:9091/ks/open\_lib；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

3. 查询开放底库

• 接口功能描述：查询开放底库（按设备、分组、名称、外部id、更新时间查询）；

• 接口路径：[GET] http://设备IP:9091/ks/open\_lib；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

4. 删除开放底库

• 接口功能描述：删除工服；

• 接口路径：[DELETE] http://设备IP:9091/ks/open\_lib；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明

• 响应示例

5. 载入底库

• 接口功能描述：增加、修改、删除后需要调用一次使其生效，为避免影响检测，此接口不能频繁调用，最好是一批操作结束后通知用户手动调用；

• 接口路径：[POST] http://设备IP:9091/ks/open\_lib/load；

• 请求参数说明：无；

• 响应参数说明；

• 响应示例。

6. 添加或修改开放底库图像

• 接口功能描述：添加或者修改开放底库图像；

• 接口路径：[PUT] http://设备IP:9091/ks/open\_lib/image；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

7. 下载模板

• 接口功能描述：下载模板；

• 接口路径：[GET] http://设备IP:9091/ks/open\_lib/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

8. 批量导入

• 接口功能描述：批量导入；

• 接口路径：[POST] http://设备IP:9091/ks/open\_lib/xlsx；

• 请求参数说明；

表. 请求参数

• 请求示例；

• 响应参数说明；

• 响应示例。

9. 批量导出

• 接口功能描述：批量导出开放底库；

• 接口路径：[GET] http://设备IP:9091/ks/open\_lib/xlsx；

• 请求参数说明；

表. 请求参数

注意：前端调用时，还需指定responseType:'blob'。

• 请求示例；

• 响应参数说明；

• 响应示例。

1. 获取token

（注：盒子平台上的接口都不需要验签，若想将平台集成在自有平台，可以采用以下接口获取token，或在“系统设置”->“运维系统”->“安全设置”中开启免登录）

需要登录盒子平台（“系统设置”->“运维系统”->“安全设置”）查看Access Key ID和Access Key Secret

• 接口功能描述：获取token；

• 接口路径：[GET]http://云服务IP:9091/ks/user/token；

• 请求参数说明；

• 请求示例；

• 响应参数说明；

• 响应示例。

2. 生成signature

需要登录上位机平台查看Access Key ID和Access Key Secret

• Python示例：

import hashlibimport hmacimport logging# 配置日志记录器LOGGER = logging.getLogger(__name__)logging.basicConfig(level=logging.INFO)defgenerate_signature(sk: str, ak: str, timestamp: int, nonce: str) -> str:    """    生成数据的HMAC-SHA256签名    Args:        sk: 秘钥        ak: 用户id        timestamp: 时间戳（秒）        nonce: UUID，长度不超过64    Returns: 签名    """try:        iflen(nonce) > 64:            LOGGER.error('The length of nonce is too long: {}, limit is 64'.format(len(nonce)))            returnNone        message = '{}:{}:{}'.format(ak, timestamp, nonce)        sk_bytes = sk.encode('utf-8')        data_bytes = message.encode('utf-8')        hmac_obj = hmac.new(sk_bytes, data_bytes, hashlib.sha256)        signature = hmac_obj.hexdigest()        return signature    except Exception as e:        LOGGER.exception('generate_signature')        returnNone# 示例使用sk = 'Access Key Secret'ak = 'Access Key ID'timestamp = int(time.time())nonce = 'random_string'signature = generate_signature(sk, ak, timestamp, nonce)print('Signature:', signature)复制代码

• JAVA示例：

import javax.crypto.Mac;import javax.crypto.spec.SecretKeySpec;import java.nio.charset.StandardCharsets;import java.security.MessageDigest;import java.util.logging.Logger;publicclassSignatureGenerator {    privatestaticfinalLoggerLOGGER= Logger.getLogger(SignatureGenerator.class.getName());    publicstatic String generateSignature(String sk, String ak, long timestamp, String nonce) {        try {            if (nonce.length() > 64) {                LOGGER.severe("The length of nonce is too long: " + nonce.length() + ", limit is 64");                returnnull;            }            Stringmessage= String.format("%s:%d:%s", ak, timestamp, nonce);            MachmacSHA256= Mac.getInstance("HmacSHA256");            SecretKeySpecsecretKey=newSecretKeySpec(sk.getBytes(StandardCharsets.UTF_8), "HmacSHA256");            hmacSHA256.init(secretKey);            byte[] hash = hmacSHA256.doFinal(message.getBytes(StandardCharsets.UTF_8));            StringBuilderhexString=newStringBuilder(2 * hash.length);            for (byte b : hash) {                Stringhex= Integer.toHexString(0xff & b);                if (hex.length() == 1) {                    hexString.append('0');                }                hexString.append(hex);            }            return hexString.toString();        } catch (Exception e) {            LOGGER.severe("generate_signature: " + e.getMessage());            returnnull;        }    }    publicstaticvoidmain(String[] args) {        Stringsk="Access Key Secret";        Stringak="Access Key ID";        longtimestamp= System.currentTimeMillis() / 1000;        Stringnonce="random_string";        Stringsignature= generateSignature(sk, ak, timestamp, nonce);        System.out.println("Signature: " + signature);    }}复制代码

• JavaScript示例：

<!DOCTYPE html>    <scriptsrc="https://cdn.bootcss.com/crypto-js/3.1.9-1/crypto-js.js"></script><script>var ak = 'ak';        var sk = 'sk';var timestamp = 1722995536;var nonce = 'nekjwdfka';var message =`${ak}:${timestamp}:${nonce}`;        var hash = CryptoJS.HmacSHA256(message, sk);        var signature = CryptoJS.enc.Hex.stringify(hash);    </script></html>复制代码

3. 更新token

• 接口功能描述：更新token（token过期时间为1小时）；

• 接口路径：[GET]http://云服务IP:9091/ks/user/token_by_token；

• 请求参数:

• 响应参数说明；

l 响应示例。

5. Postman快速获取token

打开postman中的http://IP:9091/ks/user/token 接口，在此接口的Scripts标签页的Pre-request，如下图位置添加代码即可快速获取token。

varCryptoJS = require('crypto-js');var ak = "67c028f1c38062137d1b88d1";   // 盒子后台查看var sk = "19f07f37-5b13-4482-94fb-3f7ad0b5d547"; // 盒子后台查看var timestamp = Math.floor(Date.now() / 1000);var nonce = Math.random().toString(36).substring(2, 18); var message = `${ak}:${timestamp.toString()}:${nonce}`;var hash = CryptoJS.HmacSHA256(message, sk);var signature = CryptoJS.enc.Hex.stringify(hash);console.log("ak:", ak);console.log("timestamp:", timestamp);console.log("nonce:", nonce);console.log("signature:", signature);// 清除旧的查询参数pm.request.url.query.clear();pm.request.url.addQueryParams([    { key: 'ak', value: ak },    { key: 'timestamp', value: timestamp.toString() },    { key: 'nonce', value: nonce },    { key: 'signature', value: signature }]);