自定义关键词删除接口
2023.02.06 16:44:56
易盾内容安全自定义关键词接口可以根据布控需要自定义调整拦截策略
接口说明
通过该接口可以删除已抄送的自定义关键词信息，易盾会同步刷新删除后信息
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权，所有接口每一次请求都需要包含签名信息（signature 参数），以验证用户身份，防止信息被恶意篡改。目前支持MD5，SHA1，SHA256，SM3几种加密算法，详细信息，请参见接口鉴权
接口要求
- 单次删除不超过200词
接口耗时
自定义关键词删除接口建议超时时间1s
请求
请求地址
| 名称 | 值 |
|---|---|
| HTTP URL | http://as.dun.163.com/v1/keyword/delete |
| HTTP Method | POST |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | String | 是 | 固定值："application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成
公共参数
公共参数包含密钥信息和参数签名信息，公共参数详细见请求公共参数
业务参数
| 名称 | 类型 | 必填 | 最大长度 | 描述 |
|---|---|---|---|---|
| version | String | 是 | 4 | 接口版本号，可选值 v1 |
| ids | String | 是 | 200条/次 | 关键词唯一标识id列表，逗号分隔 |
| keywords | String | 否 | keywords=["关键词1","关键词2"]，与ids必需填写一个，当ids与keywords同时存在时，只取ids | |
| sceneName | String | 否 | 32 | 产品业务组名称，不为空时删除该产品业务组下的关键词 |
请求体示例
ids=163,126&version=v1&signature=xxx&secretId=xxx&businessId=xxx&&nonce=427093960×tamp=1662011085201
响应
响应结果
响应字段如下，响应通用字段已省略，详细见响应公共字段：
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| result | Boolean | 是 | 响应结果 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": true
}
响应返回码
响应返回码见：响应返回码
接入示例代码
开发工具集（SDK）接入
为方便 JAVA 开发者调试和接入API，我们提供了配套的开发工具集（SDK），用于简化API接入流程。SDK中各接口调用方式基本相同，接入方式统一，并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程，以及使用SDK的简单示例。
- 准备工作
准备步骤详见通用步骤
- 使用方法
该接口的使用方法可参考SDK demo
API接入
如果您选择非SDK接入，使用API方式接入，请参考各开发语言汇总示例代码
该接口的使用方法具体示例如下：
