渠道反作弊API
更新时间:2024-06-27
概述
URL
项目 | 解释 |
---|---|
地址 | https://afd.baidubce.com/rcs/sync-saas |
说明 | 风控大脑根据入参给出风险级别;请求和响应中所有的文本都使用UTF-8编码 |
请求方式 | http POST |
认证机制
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为: bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。
- 如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;
- 如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证机制。
接口说明
功能描述
调用方传递zid,imei,phone等设备参数(或参数组合)给渠道反作弊接口,风控大脑云端实时判断渠道作弊风险指数,业务安全风控大脑通过接口回传风险等级以及标签给调用方。
接入参数(HTTP POST Body)JSON格式
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
sc | string | 是 | 渠道反作弊场景标识,区分渠道新增和调起 |
zid | string | 是 | 唯一标识 |
imei | string | 安卓设备必选 | android设备imei |
idfa | string | ios设备必选 | ios设备idfa |
ip | string | 是 | 客户端ip |
app | string | 是 | 使用app类型(ios/android/universe) |
c_ts | string | 是 | 事件发生时间戳 |
cid | string | 是 | 渠道号标识 |
idfv | string | 否 | ios设备标识idfv |
phone | string | 否 | 电话号码 (sha1加密后) |
mac | string | 否 | 设备mac地址 |
brand | string | 否 | 设备品牌 |
model | string | 否 | 设备型号 |
appid | string | 是 | 应用app唯一标识(区分宿主) |
aid | string | 是 | 活动id |
os_ver | string | 是 | 操作系统版本 |
reso | string | 否 | 屏幕分辨率 |
size | string | 否 | 屏幕尺寸 |
接入参数举例
{
"sc": "channel",
"c_ts": "1584871823371",
"m": "3fae11dea7c6543266d1ce4183d7826e2d494afb",
"ip": "125.124.234.121",
"app": "android",
"appid": "1",
"cid": "xxxxxx",
"aid": "99xx",
"zid": "at8TermQ1qVdEokgqxb1LpiGdDDIHv258FKGKh9U3liFHWQhyC_1NsXRYV6avhrsfgeejvaAWmYs4agXcnG1T8jvMuA",
"imei": "863811016480000",
"brand":"huawei",
"model": "huawei p20",
"os_ver": "11.10.2"
}
响应结果(HTTP Response)
正常返回结果
类别 | 属性 | 说明 | |
---|---|---|---|
request_id | string类型 | 请求唯一id | |
ret_code | 0 | 查询成功 | |
400 | 客户端错误 | ||
500 | 服务器内部错误 | ||
ret_data | level | black | 黑 |
white | 白 | ||
label | black_dev:设备本身识别为风险设备 idc_ip:登录的客户端IP为IDC hacker_ip:行为异常且IP近期有恶意行为记录 invalid_imei:IMEI伪造或不合法 ... |
正常返回结果示例
{
"request_id": "4224910025",
"ret_data": {
"level":"black",
"lable":["black_dev"]
},
"ret_code": 0
}
异常返回结果
字段名称 | 类型 | 描述 |
---|---|---|
request_id | string | 服务端请求ID |
ret_code | int | 错误码: 0 - 正常 400 – 客户端错误 500– 服务端错误 |
ret_msg | string | 出错信息 |
异常返回结果示例
{
"request_id": "4224910025",
"ret_code": 400,
"ret_msg": "Request Miss Params"
}
超时建议
超时时间建议: 当风控接口响应时间过长时,为保障业务顺利运行,业务需要默认放行该次请求,建议超时时间设为200-500ms;
超时重试频次建议: 针对重要业务场景,可增加超时重试逻辑。依旧超时情况下放行处理,优先保障业务正常运行。