接口说明
用户数据人工审核的结果,客户可以通过轮询调用该接口获取结果数据。
接口耗时
提交接口的响应较快,正常100ms内返回结果,业务方根据需求适当调整超时时间,建议为1s
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | https://openapi.dun.163.com/openapi/v2/audit/userCensor/callback |
HTTP Method | GET |
请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
X-YD-SECRETID | String | 是 | 商户密钥,请联系您的易盾策略经理配置,对应客户秘钥-AccessKey ID |
X-YD-TIMESTAMP | String | 是 | 请求当前 UNIX 时间戳,单位毫秒,请注意服务器时间是否同步 |
X-YD-NONCE | String | 是 | 随机整数,与 timestamp 联合起来,用于防止重放攻击 |
X-YD-SIGN | String | 是 | 采用sha1进行签名,验签内容: 请求的body请求串+ AccessSecretKey + timstamp + nonce 进行 |
OPENAPI签名说明
流程说明: 用户在访问易盾的 OpenAPI 时,都需要对发送到易盾的 HTTP 请求进行签名,以便于易盾能够识别发送请求的用户。需要使用访问密钥来对请求进行签名,访问密钥由易盾颁发的AccessKey ID和AccessKey Secret 组成,具体的签名步骤参见文档。
签名获取说明
对所有请求参数(包括所有私有参数) ,按照参数名ASCII码表升序顺序排序。如: foo=1, bar=2, foo_bar=3, baz=4排序后的顺序是bar=2, baz=4, foo=1, foobar=3。将排序好的参数名和参数值构造成字符串,格式为: key1+value1+key2+value2...。根据上面的示例得到的构造结果为: bar2baz4foo1foobar3。将上述构成的私有参数字符串后追加AccessSecretKey, Nonce, Timestamp,组成加密原始数据,结果为: bar2baz4foo1foobar3{AccessSecretKey)(Nonce){Timestamp)(大括号表示占位符,实际处理时请移除) 采用SHA1散列算法构成的原始数据进行加密返回。
请求参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
yidunRequestId | String | 否 | 64 | 幂等参数说明 |
请求体示例
https://openapi.dun.163.com/openapi/v2/audit/userCensor/callback?yidunRequestId=xxx
响应
该接口将返回请求t处理的结果状态
响应结果
响应字段的详细信息如下:
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
code | Number | 是 | 接口调用状态,200:正常,其他值:调用出错 |
msg | string | 是 | 结果说明,如果接口调用出错,那么返回错误描述 |
data | Array | 是 | 回调结果数组 |
UserCensorResult
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
account | Number | Y | 用户帐号 |
censorLabels | Array | Y | 标签信息 |
UserCensorLabel
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
code | String | Y | 标签id |
name | String | Y | 标签名称 |
customCode | String | 否 | 自定义标签id |
desc | String | 否 | 描述 |
响应体示例
{
"code": 200,
"msg": "成功",
"data": [{
"account": "UserId1",
"censorLabels": [{
"code": "code1",
"name": "标签名称1",
"customCode": "xxxxx1",
"desc": "描述1"
}, {
"code": "code2",
"name": "标签名称2",
"customCode": "xxxxx2",
"desc": "描述2"
}
]
}
]
}