跳到主要内容

查询指定人物名单中的人物和特征

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/person-library/feature/search/<secretId>
提示

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

1.2 请求方法​

POST

1.3 请求头​

请求头名称取值是否必需示例说明
Content-Typeapplication/json是Content-Type: application/json请求数据类型为 JSON
X-API-Key<API Key>是X-API-Key: <API Key>API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key

1.4 请求参数​

参数名称类型是否必需说明
personLibraryIdString是人物名单 id
timestampInt否当前服务器的 Unix 时间戳。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
nonceFloat否随机数（建议使用 Unix 时间戳或若干位随机整数）。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
signatureString否

RSA-SHA256 算法签名。

当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权。

签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名方式及示例

1.5 请求示例​

{
  "personLibraryId": "<personLibraryId>",
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
}

2. 响应​

2.1 响应内容​

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

2.2 响应参数​

参数名称类型是否可能为空说明
codeInt否状态码
nonceFloat否随机数（建议使用 Unix 时间戳或若干位随机整数）
messageString否相关信息
timestampInt否时间戳
personArray<Person>否名单信息，详见 Person 说明

Person 说明​

参数名称类型是否可能为空说明
personIdString否人物 id
featuresArray<Feature>否特征信息，详见 Feature 参数说明

Feature 参数说明​

参数名称类型是否可能为空说明
feature_idString否特征 ID
person_idString否人物 id
pathString否图片 uri
locationString否人脸方框坐标以图片左上角为原点，分别是 [左上角坐标,右上角坐标,右下角坐标,左下角坐标], 坐标值是相对于图片大小的百分比形式
statusString否特征上下线状态; 1: 已上线，2: 已下线
featureArray[Int]否特征值
thresholdArray[Int]否特征阈值

2.3 响应示例​

{
    "code": 0,
    "message": "success",
    "nonce": 0.865335013001561,
    "person": [
        {
            "person_id": "xxx",
            "features": [
                {
                    "feature_id": "xxx",
                    "person_id": "64c76b89b37935001de659ea",
                    "origin_path": "xxx.png",
                    "path": "xxx.png",
                    "location": [
                        [
                            0.36888570255703396,
                            0.41559216380119324
                        ],
                        [
                            0.7482205496893989,
                            0.41559216380119324
                        ],
                        [
                            0.7482205496893989,
                            0.6865880489349365
                        ],
                        [
                            0.36888570255703396,
                            0.6865880489349365
                        ]
                    ],
                    "feature": [
                        -0.017939381,
                        0.07351213
                    ],
                    "status": 1,
                    "threshold": [
                        0.1,
                        0.6
                    ]
                }
            ]
        }
    ],
    "timestamp": 1691736228
}

3. 更新日志​

日期说明
2025-06-17新增 API Key 接口鉴权方式，简化接口鉴权。废弃签名鉴权方式，仅保持兼容（采用签名鉴权方式的调用不受影响）