2025.04.01 13:52:38
接口说明
结果主动推送模式以数据为维度,将人工审核结果推送给客户,需客户方提供一个回调接收接口url给客户经理进行配置,客户方需保证回调接收接口的可用性和稳定性,确保能正常接收推送过来的结果数据。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。详细信息,请参见接口鉴权
接入说明
协议说明:客户方提供一个回调接收接口url给客户经理进行主动推送配置(即一个 http(s) 协议接口的 URL)。主动推送接口需要支持 http 协议,支持 POST 方法,传输数据编码采用 utf-8 接口性能:推送结果接口默认超时时间为 2s,为了保证顺利接收数据,客户需保证接收接口可用性和性能稳定 失败重试:客户接口处理结果数据,并返回应答。如果客户接口请求异常,超时或收到的应答不符合规范,易盾会认为推送失败;我们将每隔 10 分钟推送一次,如果一直失败,持续一天后不再推送 幂等性:结果推送时同样的结果可能会多次请求客户接口。客户接口需要保证幂等性,能够正确处理重复结果数据
接口耗时
客户接收接口需保证接收接口可用性和性能稳定,易盾请求超时时间为 2s,客户接口尽量保证在 1s 内返回应答,如有特殊要求,可联系易盾运营适当调整超时时间
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | 回调地址 callbackUrl |
HTTP Method | post |
请求头
名称 | 类型 | 描述 |
---|---|---|
Content-Type | String | 固定值:"application/x-www-form-urlencoded" |
请求参数
名称 | 类型 | 必填 | 最大长度 | 描述 |
---|---|---|---|---|
secretId | String | 是 | 32 | 商户密钥,请参见官网AccessKey管理配置。默认使用创建时间最早且有效的密钥对 |
signature | String | 是 | 32 | 请求签名,用来验证此次请求的合法性,具体算法见接口鉴权 |
callbackData | String | 是 | - | 主动推送结果数据,格式为 json 字符串,主动推送数据格式和字段描述参考示例 |
请求体示例
callbackData=***&signature=xxx&secretId=xxx callbackData为json字符串格式,请自行解析或者反序列化成json对象使用
UserCensorResult
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
account | Number | 是 | 用户帐号 |
censorLabels | Array |
是 | 标签信息 |
UserCensorLabel
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
code | String | 是 | 标签id |
name | String | 是 | 标签名称 |
customCode | String | 否 | 自定义标签id |
desc | String | 否 | 描述 |
请求体示例
{
"secretId":"n6jn7ULlOExTwoQ7KhhlIh7KqZA"
"signature":"bbba8cf6fde2a090917c060397b4d3e9",
"callbackData": {
"account": "UserId1",
"censorLabels": [{
"code": "code1",
"name": "标签名称1",
"customCode": "xxxxx1",
"desc": "描述1"
}, {
"code": "code2",
"name": "标签名称2",
"customCode": "xxxxx2",
"desc": "描述2"
}
]
}
]
}