跳到主要内容

活体检测识别任务调用记录

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/history/liveness/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

1.2 请求方法​

POST

1.3 请求头​

Content-Type: application/json

1.4 请求参数​

参数名称类型是否必需说明
timestampString是当前服务器的 Unix 时间戳，可以是毫秒或秒级
nonceString是随机数
signatureString是

RSA-SHA256 算法签名。签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
startTimeString是时间范围，起始时间 (时间格式 yyyy-MM-dd hh:mm:ss)
endTimestring是时间范围，结束时间 (时间格式 yyyy-MM-dd hh:mm:ss)
pageNumber是分页参数，查询页码
limitNumber是分页参数，每页大小
sortNumber否排序，-1：倒序，1：顺序
sortByString否排序字段
tagString否用户备注，用于给图片或文本附加额外信息
originalFileString否源文件链接
reviewBoolean否汇总结果，数据状态，是否需要复审
labelsArray<Number>否机器识别标签
similarityObject<Similarity>否相似度参数，详见 Similarity 参数说明

similarity 参数说明​

参数名称类型是否必须说明
gtNumber否大于值，取值范围 (0~100)
ltNumber否小于值，取值范围 (0~100)

1.5 请求示例​

{
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
  "startTime": "2022-12-02 00:00:00",
  "endTime": "2022-12-08 00:00:00",
  "page": 20,
  "limit": 1,
  "similarity": {
    "gt": 50,
    "lt": 70,
  },
  "originalFile": "bld",
  "tag": "tag1",
  "review": false,
  "labels": [1,2],
  "sort": -1,
  "sortBy": "similarity",
}

2. 响应​

2.1 响应内容​

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数​

参数名称类型是否可能为空说明
hasNextBoolean否是否存在下一页
totalNumber否调用记录总数
dataArray<liveness>否调用总览信息，详见 liveness 参数说明

liveness 参数说明​

参数名称类型是否可能为空说明
secretIdString否应用 ID
secretTaskIdString否项目 ID
taskDescIdString否识别任务 ID
trainRecordIdString否模型 ID
labelNumber否识别结果，标签
similarityNumber否识别结果，相似度, (0-100)
reviewBoolean否识别结果，是否需要复审
baseObject<livenessBaseDetail>否活体检测基础图片信息，详见 livenessBaseDetail 参数说明
videoFramesArray<livenessBaseDetail>否活体检测视频帧信息，详见 livenessBaseDetail 参数说明

livenessBaseDetail 参数说明​

参数名称类型是否可能为空说明
filepathString否文件缓存地址
originalFileString否源文件链接
tagString否用户备注，用于给图片或文本附加额外信息

3.2.3 响应示例​

{
    "json":"{\"code\":0,\"data\":[{\"id\":\"**************\",\"secretId\":\"**************\",\"taskDescId\":\"5c131f28153a11339add4a91\",\"secretTaskId\":\"**************\",\"trainRecordId\":\"61d53d6f28cce939ec7ed4be\",\"createTime\":\"2022-12-07T23:59:53.415+08:00\",\"label\":1,\"similarity\":68.54426575,\"review\":false,\"base\":{\"filePath\":\"**************\",\"originalFile\":\"**************\",\"tag\":\"89465802\"},\"videoFrames\":[{\"filePath\":\"**************\",\"originalFile\":\"**************\",\"tag\":\"89465802\"}}]],\"hasNext\":true,\"message\":\"success\",\"nonce\":0.6620159873192119,\"timestamp\":1670918076,\"total\":2}",
    "signature": "dIFKO9JZP/FCKZ0PO+T0GIhikHlw9YBRze/SmJj0LEkrfwhQI/mrEeHAKqiuKg0irVRCizI/OjIkgKE+nUUwUyugdrwTiIBBPW191jV3LP7Zt1G+RyDITLCgQHJEAZZ8LJ3d62yZD4lIvaPquUDY3/HpRFyJzE236n+cwPHVLa4="
}

json 字段示例

{
    "code": 0,
    "data": [
        {
            "id": "**************",
            "secretId": "**************",
            "taskDescId": "5c131f28153a11339add4a91",
            "secretTaskId": "**************",
            "trainRecordId": "61d53d6f28cce939ec7ed4be",
            "createTime": "2022-12-07T23:59:53.415+08:00",
            "label": 1,
            "similarity": 68.54426575,
            "review": false,
            "base": {
                "filePath": "**************",
                "originalFile": "**************",
                "tag": "89465802"
            },
            "videoFrames": [
                {
                    "filePath": "**************",
                    "originalFile": "**************",
                    "tag": "89465802"
                }
            ],
            "hasNext": true,
            "message": "success",
            "nonce": 0.6620159873192119,
            "timestamp": 1670918076,
            "total": 2
        }
    ]
}