跳到主要内容

查询名单中的图片内容

1. 请求

1.1 请求地址

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

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

1.2 请求方法

POST

1.3 请求头

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

1.4 请求参数

参数名称类型是否必需说明
imageLibraryIdString图片名单 ID
nameString图片名称,允许模糊搜索
isFuzzySearchBoolean是否模糊搜索, 默认为 false
pageInt第几页, 从 1 开始, 默认为 1
limitInt返回条目数限制, 默认为 10, 最大为 999
timestampInt当前服务器的 Unix 时间戳。

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

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

RSA-SHA256 算法签名。

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

签名步骤:

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

1.5 请求示例

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

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称类型是否可能为空说明
codeInt状态码
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
messageString相关信息
timestampInt时间戳
hasNextBoolean是否存在下一页
totalInt图片总数
imagesArray<image>图片信息,详见 image 参数说明

image 参数说明

参数名称类型是否可能为空说明
nameString图片名称
urlString图片链接
updatedAttime更新时间

2.3 响应示例

{
"json": "{\"code\":0,\"hasNext\":true,\"images\":[{\"name\":\"xxxxxx\",\"url\":\"https://static.tuputech.com/xxxxx\",\"updatedAt\":\"2022-11-24 08:27:20.922 +0000 UTC\"}],\"message\":\"success\",\"nonce\":0.39926257471964194,\"timestamp\":1669603816,\"total\":531}",
"signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}

3. 更新日志

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