图片名单管理接口

接口简介

通过该接口服务可以对自定义图片名单库进行操作管理,包括名单信息查询、名单内图片查询、批量入库或者删除图片等。

名词解释:

应用id:即secretId,可在登录控制台后,在“我的应用” 页面查看

图片名单id:图片名单库的中各名单的ID,可在登录控制台后,在“图片名单库” > “进入名单”页面查看

1. 根据指定应用/图片获取名单信息

请求地址

http://api.open.tuputech.com/v3/management/image-library/search

请求方法

POST

请求头

Content-Type: application/json

调用参数说明

参数名称 类型 是否必需 说明
secretId string 应用 id
name string 图片名称, 支持模糊搜索
timestamp String 当前的服务器的 Unix 时间戳,可以是毫秒或秒级。
nonce String 随机数,建议是 [0-1] 之间的小数,如:0.1527317095951506。
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。

响应参数说明

参数名称 类型 说明
imageLibraries Array

id

string 图片名单 id

name

string 图片名单名称,长度 <= 512 个字符

type

int 图片名单类型(黑白名单)

threshold

float 图片名单阈值

status

int 图片名单状态

images

int 图片名单图片数量

响应示例

{
  "imageLibraries": [
    {
      "id": "xxxx",
      "name": "xxxx",
      "type": 0,
      "threshold": 0.95,
      "status": 0,
      "images": 596
    }
  ]
}

2. 列出指定图片名单内图片

请求地址

http://api.open.tuputech.com/v3/management/image/search

请求方法

POST

请求头

Content-Type: application/json

调用参数说明

参数名称 类型 是否必需 说明
secretId string 应用 id
imageLibraryId string 图片名单 id
timestamp String 当前的服务器的Unix时间戳,可以是毫秒或秒级。
nonce String 随机数,建议是[0-1]之间的小数,如:0.1527317095951506。
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。

响应参数说明

参数名称 类型 说明
images Array

name

string 图片名称

url

string 图片链接

updatedAt

time 更新时间

响应示例

{
  "images": [
    {
      "name": "test.jpg",
      "url": "https://static.tuputech.com/lts/image/original/xxx/test.jpg",
      "updatedAt": "2022-06-16 07:01:51.935 +0000 UTC"
    }
  ]
}

3. 通过图片 url 批量增加图片

请求地址

http://api.open.tuputech.com/v3/management/image/create/url

请求方法

POST

请求头

Content-Type: application/json

调用参数说明

参数名称 类型 是否必需 说明
secretId string 应用 id
imageLibraryId string 图片名单 id
timestamp String 当前的服务器的Unix时间戳,可以是毫秒或秒级。
nonce String 随机数,建议是[0-1]之间的小数,如:0.1527317095951506。
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。
images Array 图片数量限制(1-1000)

name

string 图片名称

url

string 图片 url

响应参数说明

参数名称 类型 说明
images Array

code

int 状态码,标识该图片是否成功入库,详见服务公共状态码解析

error

string 错误原因

name

string 图片名称

url

string 图片链接

响应示例

{
   "images":[
      {
         "code":0,
         "error":"",
         "name":"test.jpg",
         "url": "https://static.tuputech.com/lts/image/original/xxx/test.jpg"
      }
   ]
}

4. 通过图片 base64 批量增加图片

请求地址

http://api.open.tuputech.com/v3/management/image/create/base64

请求方法

POST

请求头

Content-Type: application/json

调用参数说明

参数名称 类型 是否必需 说明
secretId string 应用 id
imageLibraryId string 图片名单 id
timestamp String 当前的服务器的Unix时间戳,可以是毫秒或秒级。
nonce String 随机数,建议是[0-1]之间的小数,如:0.1527317095951506。
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。
images Array 图片数量限制(1-100), 建议控制一次入库图片的总大小不超过100M,过大将导致413 Request Entity Too Large

name

string 图片名称

content

string 图片 base64

响应参数说明

参数名称 类型 说明
images Array

code

int 状态码,标识该图片是否成功入库,详见服务公共状态码解析

error

string 错误原因

name

string 图片名称

url

string 图片链接

响应示例

{
   "images":[
      {
         "code":0,
         "error":"",
         "name":"test.jpg",
         "url": "https://static.tuputech.com/lts/image/original/xxx/test.jpg"
      }
   ]
}

5. 根据图片名称批量删除图片

请求地址

http://api.open.tuputech.com/v3/management/image/delete

请求方法

POST

请求头

Content-Type: application/json

调用参数说明

参数名称 类型 是否必需 说明
secretId string 应用 id
imageLibraryId string 图片名单 id
timestamp String 当前的服务器的Unix时间戳,可以是毫秒或秒级。
nonce String 随机数,建议是[0-1]之间的小数,如:0.1527317095951506。
signature String 我们采用的数字证书签名算法是:"RSA-SHA256",签名输出类型是:"base64",具体步骤如下:
1、所有参与签名的参数为:secretId,timestamp,nonce,用英文半角逗号“,”相连,得到sign_string;
2、利用您的私钥,使用算法"RSA-SHA256"签名,输出为 "base64" 格式,得到参数signature的值。
images Array 图片数量限制(1-100)

name

string 图片名称

响应参数说明

参数名称 类型 说明
images Array

code

int 状态码,标识该图片是否成功删除,详见服务公共状态码解析

error

string 错误原因

name

string 图片名称

响应示例

{
   "images":[
      {
         "code":0,
         "error":"",
         "name":"test.jpg"
      }
   ]
}

results matching ""

    No results matching ""