跳到主要内容

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

1. 请求

1.1 请求地址

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

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

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称类型是否必需说明
timestampNumber当前服务器的 Unix 时间戳,可以是毫秒或秒级。
nonceNumber随机数,建议是 [0-1] 之间的小数,如:0.1527317095951506
signatureString

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

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
nameString图片名称,支持模糊搜索
isFuzzySearchBoolean是否模糊搜索, 默认为 false

1.5 请求示例

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

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称类型是否可能为空说明
codeNumber状态码
nonceNumber随机数
messageString相关信息
timestampNumber时间戳
imageLibrariesArray<ImageLibrary>名单信息,详见 imageLibrary 说明

ImageLibrary 说明

参数名称类型是否可能为空说明
idString图片名单 ID
nameString图片名单名称,长度小于等于 512 个字符
typeNumber图片名单类型(黑白名单)
thresholdNumber图片名单阈值
statusNumber图片名单状态
imagesNumber图片名单图片数量

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="
}