跳到主要内容

图片/应用关联的名单信息查询

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/image-library/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 请求参数​

参数名称类型是否必需说明
nameString否图片名称，支持模糊搜索
isFuzzySearchBoolean否是否模糊搜索， 默认为 false
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 请求示例​

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

2. 响应​

2.1 响应内容​

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

2.2 响应参数​

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

ImageLibrary 说明​

参数名称类型是否可能为空说明
idString否图片名单 ID
nameString否图片名单名称，长度小于等于 512 个字符
typeInt否图片名单类型（黑白名单）
thresholdInt否图片名单阈值
statusInt否图片名单状态
imagesInt否图片名单图片数量

2.3 响应示例​

 {
  "json": "{\"code\":0,\"imageLibraries\":[{\"id\":\"xxxxx\",\"name\":\"xxxxxx\",\"type\":0,\"threshold\":0.95,\"status\":0,\"images\":0}],\"message\":\"success\",\"nonce\":0.06782758396322386,\"timestamp\":1669603717}",
  "signature": "Ib83QDNUBz8fvUc2xhELAm7gGqjpIkUkxqw1LaS88ssOSuv52gD3Z3ynu8QL+pLF0S5f6EXmJYH6enOHjymuIYxbg+ToLq6+BGQQWKRyoOEpNzdtmjSqCcv+rO24sH+S76ts0PHyoz0rFUXcxjZl+aRtc0c9bOC/NgpgY+WCBkk="
}

3. 更新日志​

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