#
1. 激活- 提示:官网文档仅供参考,具体接入时请联系数美提供正式对接文档
#
1.1. 调用时机用户完成下载安装APP后,在首次启动APP初始化的时候,客户端向服务端上报激活数据,同时服务端实时调用该接口向数美反欺诈服务发送请求。
#
1.2. 具体接口请求URL
北京:http://api-skynet-bj.fengkongcloud.com/v4/event
美东(弗吉尼亚):http://api-skynet-fjny.fengkongcloud.com/v4/event
新加坡:http://api-skynet-xjp.fengkongcloud.com/v4/event
字符编码
UTF-8
请求方法
POST
建议超时时长
1s
请求参数
放在HTTP Body中,采用Json格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
accessKey | string | 用于权限认证的访问密钥,由数美提供 | 必传参数 | 数美分配 |
appId | string | 应用ID,用于区分相同公司的不同应用 | 必传参数 | 该参数传递值可与数美协商 |
eventId | string | 事件ID,用于标识事件类型 | 必传参数 | activation |
data | json object | 本次请求相关信息,详情见下文 | 必传参数 | 请见表格《data请求相关信息》 |
其中,data的内容如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
ip | string | 事件发生时的客户端公网ipv4地址 | 必传参数 | |
timestamp | int64 | 事件发生时的时间戳,单位为毫秒(ms) | 必传参数 | |
advertisingId | string | 广告计费的设备ID | 必传参数 | 一般是安卓的IMEI或苹果设备的IDFA。可以传入哈希值 |
apputm | string | 本次激活来自的渠道标识 | 必传参数 | 客户自定义字段 |
os | string | 应用端 | 必传参数 | 可选值: android、ios、weapp、web |
appVersion | string | 应用版本号 | 必传参数 | 传入当前应用或服务正在使用的版本号,格式为3个点4段数字,每段数字最多4位,例如3.2.1.1234。不足4段的请补0,例如2.1.5传入2.1.5.0。多于4段的取前4段,例如2.1.5.1.1传入2.1.5.1。 |
deviceId | string | 数美设备指纹标识 | 强烈建议 |
返回参数
放在HTTP Body中,采用Json格式,具体参数如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
requestId | string | 本次请求的唯一标识 | |
code | int | 请求返回码 | 请见表格《code请求返回码》 |
message | string | 请求返回描述,和请求返回码对应 | 请见表格《code请求返回码》 |
riskLevel | string | 当前事件的处置建议 | code为1100时存在此项 PASS:通过 REVIEW:审核 REJECT:拒绝 |
detail | json object | 风险详情信息,详情见下文 | 请见《detail结果详情》表 code为1100时存在此项 |
其中,detail的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的规则标识 | |
hits | json array | 事件命中的所有规则标识 | hits中每个字段都是一个object,详见《hits结果详情信息》 |
| riskType | int | 当前事件的风险类型 | 是对model的标签化描述,暂定6种,后续可能会调整(详见《riskType风险类型列表》) |
其中,hits结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的最高优先级规则标识 | |
riskLevel | string | 当前事件的处置建议 | PASS:通过 REVIEW:审核 REJECT:拒绝 |
riskType风险类型列表如下:
riskType | message |
---|---|
0 | 有效新增 |
100 | 积分墙设备 |
200 | 虚拟设备 |
310 | 伪造设备 |
320 | 篡改设备 |
330 | 设备农场 |
400 | 重复安装 |
410 | 升级安装 |
code请求返回码列表如下:
code | message |
---|---|
1100 | 成功 |
1901 | QPS超限(当前接口QPS上限值为150) |
1902 | 参数不合法 |
1903 | 服务失败 |
9100 | 余额不足 |
9101 | 无权限操作 |
示例
请求示例
返回示例
#
1.3. 结果处理方法业务方根据每次请求的riskType返回结果,实时生成渠道激活的业务报表。