接口说明
该接口支持客户自行提交待审用户相关信息至SAAS用户审核模块进行审核
接口耗时
提交接口的响应较快,正常100ms内返回结果,业务方根据需求适当调整超时时间,建议为1s
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | https://openapi.dun.163.com/openapi/v2/audit/userCensor/submit |
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散列算法构成的原始数据进行加密返回。
请求参数
名称 | 类型 | 必填 | 最大长度 | 描述 |
---|---|---|---|---|
clientId | String | Y | 64 | 客户ID,请联系您的易盾策略经理获取 |
account | String | Y | 128 | 用户唯一标识 |
ruleId | Number | Y | 10 | 用户审核打标规则的Id,需先在saas“用户审核管理”页面创建“用户打标”类型的规则 |
profileUrl | string | N | 2048 | 用户主页地址,用于传输这次数据的用户ID的后台地址,便于快速跳转 |
phone | string | N | 64 | 手机号,与易盾风险库匹配。默认国内手机号,如有海外手机,需包含国家地区代码,格式为“+447410xxx186(+44即为国家码)”。如果需要加密,支持传入hash值,hash算法:md5(phone) |
nickname | String | N | 128 | 用户昵称,建议抄送,辅助机审策略精准调优 |
gender | Number | N | 4 | 用户性别,0未知,1男,2女,在社交、直播场景建议抄送,辅助策略精准调优 |
age | Number | N | 4 | 用户年龄,0未知,在社交场景建议抄送,辅助策略精准调优 |
level | Number | N | 4 | 用户等级,0未知,1初级,2中级,3高级,其他值请与易盾策略约定,建议抄送,辅助策略精准调优 |
registerTime | Number | N | 13 | 注册时间,UNIX 时间戳(毫秒值) |
friendNum | Number | N | 20 | 好友数,在社交、直播场景中使用,建议抄送 |
fansNum | Number | N | 20 | 粉丝数,在社交、直播场景中使用,建议抄送 |
isPremiumUse | Number | N | 4 | 是否付费用户,0为默认值,1为付费,建议抄送,易盾将结合该信息综合判断 |
role | string | N | 32 | 用户类型角色,可针对不同的角色配置不同的策略。角色与易盾策略约定即可 |
请求体示例
https://openapi.dun.163.com/openapi/v2/audit/userCensor/submit?clientId=111&userAccount=222&ruleId=xxx
响应
该接口将返回请求处理的状态及结果
响应结果
响应字段的详细信息如下:
名称 | 类型 | 必须返回 | 描述 |
---|---|---|---|
code | Number | 是 | 接口调用状态,200:正常,其他值:调用出错 |
msg | String | 是 | 结果说明,如果接口调用出错,那么返回错误描述 |
data | Boolean | 是 | true为数据处理成功,false为数据处理失败 |
响应体示例
{ "code":200, "msg":"ok" "data":true }