API Path
/aipaas/live/v1/digitalHuman/authenticate
请求协议
HTTPS
请求方法
POST
请求头部 :
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | 内容类型 | [string] | application/json | application/json | ||
| X-APP-ID | 是 | 控制台--应用管理--创建应用--AppID | [string] | ||||
| Device-Uuid | 是 | 设备管理-设备uuid | [string] | ||||
| Authorization | 是 | 鉴权信息 | [string] |
请求参数 Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| code | 请求状态码,固定1019 | 是 | [int] | 0 | 1019 | |
| data | 算法参数 | 是 | [object] | 0 | ||
| data>>camera_id | 摄像头id | 是 | [string] | 0 | 0d04322bee08401a9c15a5ef8643e64f | |
| data>>task_id | 任务id | 是 | [string] | 0 | ||
| data>>algo_tasks | 任务列表 | 是 | [array] | 0 | ||
| data>>algo_tasks>>algo_config | 任务参数 | 是 | [object] | 0 | ||
| data>>algo_tasks>>algo_config>>version | 参数版本号,本业务不使用 | 否 | [string] | 0 | 1.0.0 | |
| data>>algo_tasks>>algo_config>>algo_roi | roi区域配置,不支持区域设置,直接用全图 | 是 | [object] | 0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>is_full_region | 是否全图。本业务固定为1。输入"0"时可自动转为false 输入"1"时可自动转为true,其他情况可能有未知错误 | 是 | [boolean] | 1:绝对坐标,2:相对坐标 | 0 | 1 |
| data>>algo_tasks>>algo_config>>algo_roi>>roi_type | roi坐标类型,本业务不使用。1 绝对坐标 2 相对坐标【is_full_region为false时必填 is_full_reg | 否 | [int] | 0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>region_mode | (v1.3.0版本后删除)区域模式,本业务不使用。1 :中心点在区域内 其他报错; | 否 | [int] | 0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list | 设定区域集合,本业务传空列表。【is_full_region为false时为必填】 | 否 | [array] | 0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>name | 区域名字,需全局唯一 | 否 | [string] | 0 | 61b3a095eb0bc49 | |
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list | 区域坐标点集【其中x,y必填】 | 否 | [array] | 0 | ||
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>x | X轴坐标 | 否 | [float] | 0 | 0.0 | |
| data>>algo_tasks>>algo_config>>algo_roi>>roi_list>>point_list>>y | Y轴坐标 | 否 | [float] | 0 | 1.0 | |
| data>>algo_tasks>>algo_config>>extra_params | 额外参数,详见5.请求参数示例 | 是 | [array] | 0 | ||
| data>>image | 图片的base64编码 | 是 | [string] | 0 | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC |
响应内容 :
返回结果
成功 (200)
Json
Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| code | 算法类型,固定1020 | 是 | [int] | 0 | 1020 | |
| data | 算法调用结果 | 是 | [object] | 0 | ||
| data>>error_code | 错误码 | 是 | [string] | 0 | APP_ERR_OK | |
| data>>error_message | 错误描述 | 是 | [string] | 0 | 正常状态 | |
| data>>camera_id | 摄像头id | 是 | [string] | 0 | A15414521025 | |
| data>>task_id | 任务id | 是 | [string] | 0 | 0d04322bee08401a9c15a5ef8643e64f | |
| data>>frame_id | 帧id | 是 | [string] | 0 | 0d04322bee08401a9c15a5ef8sldufj8 | |
| data>>frame_width | 图片宽度 | 是 | [string] | 0 | 1920 | |
| data>>frame_height | 图片高度 | 是 | [string] | 0 | 1080 | |
| data>>send_pts_ms | 告警推送时的时间戳,图片流为0 | 是 | [string] | 0 | ||
| data>>pull_pts_ms | 拉流的时间戳,图片流为0 | 是 | [string] | 0 | ||
| data>>display_image | 图片base64,图片流传空 | 是 | [string] | 0 | ||
| data>>algo_outputs | 算法处理结果数组 | 是 | [array] | 0 | ||
| data>>algo_outputs>>roi_message | 设定区域信息 | 否 | [object] | 0 | ||
| data>>algo_outputs>>roi_message>>name | 区域名字 | 否 | [string] | 0 | 61b3a095eb0bc49 | |
| data>>algo_outputs>>roi_message>>point_list | 区域点集 | 否 | [array] | 0 | ||
| data>>algo_outputs>>roi_message>>point_list>>x | 创建任务时传入的X轴坐标 | 否 | [float] | 0 | 0.0 | |
| data>>algo_outputs>>roi_message>>point_list>>y | 创建任务时传入的Y轴坐标 | 否 | [float] | 0 | 1.0 | |
| data>>algo_outputs>>roi_message>>extra_params | 区域额外参数,此业务不使用 | 否 | [array] | 0 | ||
| data>>algo_outputs>>roi_message>>extra_params>>key | 创建任务时传入的参数名 | 否 | [string] | 0 | alarm | |
| data>>algo_outputs>>roi_message>>extra_params>>value | 创建任务时传入的参数值 | 否 | [string] | 0 | 1 | |
| data>>algo_outputs>>objectinfo | 检测到的目标对象数组 | 否 | [array] | 0 | ||
| data>>algo_outputs>>objectinfo>>class_name | fake、real | 否 | [string] | 0 | 目标类别名称 | |
| data>>algo_outputs>>objectinfo>>class_id | 0:fake 1:real | 否 | [int] | 0 | 1 | |
| data>>algo_outputs>>objectinfo>>rect | 检测框 | 否 | [object] | 0 | ||
| data>>algo_outputs>>objectinfo>>rect>>x0 | 左上X轴坐标 | 否 | [int] | 0 | 0.0 | |
| data>>algo_outputs>>objectinfo>>rect>>y0 | 左上Y轴坐标 | 否 | [int] | 0 | 0.0 | |
| data>>algo_outputs>>objectinfo>>rect>>x1 | 右下X轴坐标 | 否 | [int] | 0 | 100.0 | |
| data>>algo_outputs>>objectinfo>>rect>>y1 | 右下Y轴坐标 | 否 | [int] | 0 | 100.0 | |
| data>>algo_outputs>>objectinfo>>confidence | 此业务未使用填-1 | 否 | [float] | 0 | 0.99 | |
| data>>algo_outputs>>objectinfo>>track_id | 目标跟踪id,本业务无效 | 否 | [string] | 0 | 0d04322bee0 | |
| data>>algo_outputs>>objectinfo>>score | 得分,此业务使用该得分 | 否 | [float] | 0 | 0.99 | |
| data>>algo_outputs>>objectinfo>>feature | 特征值,此业务未使用 | 否 | [array] | 0 | [0.0620517209172249, 0.0471773408353329] | |
| data>>algo_outputs>>objectinfo>>attribute | 属性值,此业务未使用 | 否 | [array] | 0 | ||
| data>>algo_outputs>>objectinfo>>attribute>>key | 属性名称 | 否 | [string] | 0 | sex | |
| data>>algo_outputs>>objectinfo>>attribute>>value | 属性值 | 否 | [string] | 0 | 1 | |
| data>>algo_outputs>>objectinfo>>attribute>>score | 属性置信度(0~1),未知为-1 | 否 | [float] | 0 | 0.99 | |
| data>>algo_outputs>>objectinfo>>extra_message | 目标额外信息 | 否 | [array] | 0 | ||
| data>>algo_outputs>>objectinfo>>extra_message>>key | 参数名 | 否 | [string] | 0 | ||
| data>>algo_outputs>>objectinfo>>extra_message>>value | 参数值 | 否 | [string] | 0 | ||
| data>>algo_outputs>>objectinfo>>image_message | 额外信息,此业务未使用 | 否 | [array] | 0 | ||
| data>>algo_outputs>>objectinfo>>image_message>>key | 图片名称 | 否 | [string] | 0 | xxx.jpg | |
| data>>algo_outputs>>objectinfo>>image_message>>value | 图片Base64【jpeg格式base64编码】 | 否 | [string] | 0 | iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAMAAADXqc3KAAAAFVBMVEX////7ODj+z8/9eHj9m5v9s7P7TEwZgBMVAAAACXBIWXMAAAsTAAALEwEAmpwYAAAATklEQVQokd2NQQqAQAzEMjNd//9kUXEXFw8eBMEcCiUlha9p8lspC6ukwDZHeBcBNcvUJICkAjwVheV2k4pUkMvzWo5U307kLiSNkz+wAvF5AMTthEMUAAAAAElFTkSuQmCC | |
| data>>extra_message | 额外信息,本业务未使用 | 否 | [array] | 0 | ||
| data>>image_message | 额外参数,此业务未使用 | 否 | [array] | 0 |
成功示例
{
"code": 1020,
"data": {
"error_code": "APP_ERR_OK",
"error_message": "",
"camera_id": "1",
"task_id": "perf_bllj_20230507_0601_000071.jpg",
"frame_id": "129",
"frame_width": "1920",
"frame_height": "1080",
"send_pts_ms": "1733813387513",
"pull_pts_ms": "0",
"display_image": "",
"algo_outputs": [{
"objectinfo": [{
"class_name": "auth",
"rect": {
"x0": 0,
"y0": 0,
"x1": 1920,
"y1": 1080
},
"track_id": "",
"extra_message": [
],
"image_message": [
],
"feature": [
],
"attribute": [
],
"class_id": 1,
"confidence": -1,
"score": 0.949770868
}]
}],
"extra_message": [
],
"image_message": [
]
}
}
换脸鉴伪能力,配合摄像头过滤一部分伪造图片,实现拦截
| 修订日期 | 算法版本号 | 修订内容 |
|---|---|---|
| 2025-12-12 | V1.3.0 | 适配atlas300I duo平台,增加状态码说明;请求入参extra_params增加threshold字段,region_mode删除,返参增加class_name和class_id输出说明 |
| 2025-09-15 | V1.2.0 | 无 |
| 2025-05-20 | v1.6.5.6 | 初始化API文档 |
服务接口调用时需要严格遵循服务鉴权规则,服务调用鉴权规则请参见:开发指南 - 签名认证方式。
| extra_message | Array | 说明 | |
|---|---|---|---|
| "key":"lamks “ | string | 一维数组 | |
| "value": [160,358,160,384,...] | array | 格式如样例,必须是106个点,也就是212个数。 | |
| "key":"threshold“ | string | 分类的阈值 | |
| "value": 0.6 | float | score>=该阈值 为真,<=该阈值为假。不填默认为0.6 |
{
"code": 1020,
"data": {
"error_code": "APP_ERR_OK",
"error_message": "",
"camera_id": "1",
"task_id": "perf_bllj_20230507_0601_000071.jpg",
"frame_id": "129",
"frame_width": "1920",
"frame_height": "1080",
"send_pts_ms": "1733813387513",
"pull_pts_ms": "0",
"display_image": "",
"algo_outputs": [{
"objectinfo": [{
"class_name": "auth",
"rect": {
"x0": 0,
"y0": 0,
"x1": 1920,
"y1": 1080
},
"track_id": "",
"extra_message": [
],
"image_message": [
],
"feature": [
],
"attribute": [
],
"class_id": 1,
"confidence": -1,
"score": 0.949770868
}]
}],
"extra_message": [
],
"image_message": [
]
}
}
{
"code": 1019,
"data": {
"camera_id": "e63313f483e011f0964c00163e0228ba",
"task_id": "f04aa30283e011f0964c00163e0228ba",
"algo_tasks": [{
"algo_config": {
"version": "",
"algo_roi": {
"is_full_region": true,
"roi_type": 1,
"roi_list": []
},
"extra_params": [{
"key": "lamks",
"value": "[160,358,160,384,...]"
},
{
"key": "threshold",
"value": "0.6"
}
]
}
}],
"image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgIBBm..."
}
}
| 状态码 | 状态描述 | 状态说明 | 对应数字编码 |
|---|---|---|---|
| APP_ERR_OK | 正常状态 | ok | 0 |
| APP_ERR_FAILURE | 系统异常 | error | -1 |
| APP_PAGRAM_ERR_FAILURE | 参数异常 | Invalid parameter | 10 |
| APP_ERR_COMM_FAILURE | 失败 | General Failed | 1001 |
| APP_ERR_COMM_INNER | 内部错误 | Internal error | 1002 |
| APP_ERR_COMM_INVALID_POINTER | 无效指针 | Invalid Pointer | 1003 |
| APP_ERR_COMM_INVALID_PARAM | 无效参数 | Invalid parameter | 1004 |
| APP_ERR_COMM_UNREALIZED | 未实现 | Not implemented | 1005 |
| APP_ERR_COMM_OUT_OF_MEM | 内存溢出 | Out of memory | 1006 |
| APP_ERR_COMM_ALLOC_MEM | 内存分配错误 | memory allocation error | 1007 |
| APP_ERR_COMM_FREE_MEM | 内存释放错误 | free memory error | 1008 |
| APP_ERR_COMM_OUT_OF_RANGE | 内存越界 | out of range | 1009 |
| APP_ERR_COMM_NO_PERMISSION | 无权限 | NO Permission | 1010 |
| APP_ERR_COMM_TIMEOUT | 超时 | Timed out | 1011 |
| APP_ERR_COMM_NOT_INIT | 未初始化 | Not initialized | 1012 |
| APP_ERR_COMM_INIT_FAIL | 初始化错误 | initialize failed | 1013 |
| APP_ERR_COMM_INPROGRESS | 操作正在进行中 | Operation now in progress | 1014 |
| APP_ERR_COMM_EXIST | 资源已存在 | Object; file or other resource already exist | 1015 |
| APP_ERR_COMM_NO_EXIST | 资源不存在 | Object; file or other resource doesn't exist | 1016 |
| APP_ERR_COMM_BUSY | 资源在使用中 | Object; file or other resource is in use | 1017 |
| APP_ERR_COMM_FULL | 无可用资源 | No available Device or resource | 1018 |
| APP_ERR_COMM_OPEN_FAIL | 文件或资源打开失败 | Device; file or resource open failed | 1019 |
| APP_ERR_COMM_READ_FAIL | 文件或资源读失败 | Device; file or resource read failed | 1020 |
| APP_ERR_COMM_WRITE_FAIL | 文件或资源写失败 | Device; file or resource write failed | 1021 |
| APP_ERR_COMM_DESTORY_FAIL | 文件或资源释放失败 | Device; file or resource destory failed | 1022 |
| APP_ERR_COMM_EXIT | 数据流结束,退出程序 | End of data stream; stop the application | 1023 |
| APP_ERR_COMM_CONNECTION_CLOSE | 连接断开 | Out of connection; Communication shutdown | 1024 |
| APP_ERR_COMM_CONNECTION_FAILURE | 连接失败 | connection fail | 1025 |
| APP_ERR_COMM_STREAM_INVALID | 无效流 | ACL stream is null pointer | 1026 |
| APP_ERR_COMM_REGION_ERROR | 区域校验失败 | region error | 1027 |
| APP_ERR_COMM_DECODE_FAIL | 图片解码失败 | Image decode fail | 1028 |
| APP_ERR_COMM_MODELINIT_FAIL | 模型初始化失败 | Model init fail | 1029 |
| APP_ERR_COMM_MODELINFER_FAIL | 模型推理失败 | Model infer fail | 1030 |
| APP_ERR_COMM_PARAM_FAILURE | 参数校验失败 | param check fail | 1031 |
| APP_ERR_STREAMPULLER_BASE | 拉流模块(视频流有效) | For StreamPuller | 2000 |
| APP_ERR_STREAMPULLER_OPEN_FAIL | 流打开失败(视频流有效) | Open input stream failed | 2001 |
| APP_ERR_STREAMPULLER_STREAMINFOFIND_FAIL | 查找流信息失败(视频流有效) | Find stream information failed | 2002 |
| APP_ERR_STREAMPULLER_EOF | 流结束(视频流有效) | Stream if EOF | 2003 |
| APP_ERR_STREAMPULLER_READFRAME_FAIL | 读取帧失败(视频流有效) | Stream read error frame | 2004 |
| APP_ERR_STREAMPULLER_REOPEN_FAIL | 重新打开流失败(视频流有效) | Reopen input stream failed | 2005 |
| APP_ERR_STREAMPULLER_STREAMFIND_FAIL | 查找视频channel失败(视频流有效) | Find no video stream | 2006 |
| APP_ERR_STREAMPULLER_STREAMFORMAT_ERROR | 不支持的视频格式(视频流有效) | Stream is unsupported video format | 2007 |
| APP_ERR_VIDEODECODER_BASE | 解码模块(视频流有效) | For Videodecoder | 2020 |
| APP_ERR_VIDEODECODER_CREATE_FAIL | 创建解码器失败(视频流有效) | Create MxBase::VideoDecoder Exception | 2021 |
| APP_ERR_VIDEODECODER_UNSUPPORT_FORMAT | 不支持的视频格式(视频流有效) | Stream is unsupported video format | 2022 |
| APP_ERR_VIDEODECODER_DECODE_FAIL | 视频解码失败(视频流有效) | decode fail | 2023 |
| APP_ERR_CONFIG_BASE | 参数配置 | For modulebase | 2040 |
| APP_ERR_CONFIG_ADD_FAIL | 添加参数失败 | Add new algo config failed | 2041 |
| APP_ERR_CONFIG_UPDATE_FAIL | 更新参数失败 | update config failed | 2042 |
| APP_ERR_CONFIG_DELETE_FAIL | 删除参数失败 | delete config failed | 2043 |
| APP_ERR_QUEUE_BASE | 队列 | 5000 | |
| APP_ERR_QUEUE_EMPTY | 队列为空 | Queue: empty queue | 5001 |
| APP_ERR_QUEUE_STOPED | 队列已停止 | Queue: queue stoped | 5002 |
| APP_ERR_QUEUE_FULL | 队列满 | Queue: full queue | 5003 |