跳到主要内容

新增文本名单

1. 请求

1.1 请求地址

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

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

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称类型是否必需说明
timestampInt当前服务器的 Unix 时间戳,可以是毫秒或秒级。
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
signatureString

RSA-SHA256 算法签名。

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

签名步骤:

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
nameString文本名单库名称
labelString文本名单一级标签,详见 label 说明
subLabelString文本名单一级标签,英文
statusInt状态,其中开启为 0,关闭为 1,默认为开启
secretIdsArray<String>名单库绑定的应用(SID)数组。

1. 当该字段不存在(或值为 null/nil)时,默认绑定当前应用;
2. 当该字段不包含当前应用(或值为空数组 [ ])时,自动填充当前应用;
3. 当该字段包含未启用状态的应用时,接口返回参数错误;
(当前应用指您在接口 URL 中填写的 SID)

Label 说明

名称说明
Normal正常
Terror暴恐
Sensitive敏感
ADs广告
Politics涉政
Porn色情
Abuse谩骂
Nonsense灌水
UserDefine自定义
Minors未成年

1.5 请求示例

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

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称类型是否可能为空说明
codeInt状态码
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
messageString相关信息
timestampInt时间戳
thesaurusObject<Thesaurus>名单信息,详见 Thesaurus 结果说明

Thesaurus 结果说明

参数名称类型是否可能为空说明
idString文本名单库 id
nameString文本名单名称
labelString文本名单一级标签
subLabelString文本名单二级标签
statusString状态
secretIdsArray<String>名单绑定的应用(SID)数组
keywordsInt词条数量

2.3 响应示例

{
"json": "{\"code\":0,\"message\":\"success\",\"nonce\":0.4880469322753077,\"thesaurus\":{\"id\":\"xxx\",\"name\":\"xxxx\",\"label\":\"ADs\",\"subLabel\":\"xxx\",\"status\":0,\"secretIds\":[\"xxx\"],\"keywords\":0},\"timestamp\":1672130233}",
"signature": "MmAqSzX8fq5OTTAtakcLNB6KQOs08u5HDoHQPhiRKISRK+zePPhlmWWoMMua7wTGZV2gb1go4apnZfgKkQE/WGjEwJrEPDuHOfH8t2vZflPQVa7HyL7EI06ZwpTDTjqCimOqRQhrIajww3xtoVpA+s6P1b1xROwu8xFy7VtOFr4="
}