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格式,具体参数如下:

请求参数名类型参数说明传入说明备注
accessKeystring用于权限认证的访问密钥,由数美提供必传参数数美分配
appIdstring应用ID,用于区分相同公司的不同应用必传参数该参数传递值可与数美协商
eventIdstring事件ID,用于标识事件类型必传参数activation
datajson object本次请求相关信息,详情见下文必传参数请见表格《data请求相关信息》

其中,data的内容如下:

请求参数名类型参数说明传入说明备注
ipstring事件发生时的客户端公网ipv4地址必传参数
timestampint64事件发生时的时间戳,单位为毫秒(ms)必传参数
advertisingIdstring广告计费的设备ID必传参数一般是安卓的IMEI或苹果设备的IDFA。可以传入哈希值
apputmstring本次激活来自的渠道标识必传参数客户自定义字段
osstring应用端必传参数可选值: android、ios、weapp、web
appVersionstring应用版本号必传参数传入当前应用或服务正在使用的版本号,格式为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。
deviceIdstring数美设备指纹标识强烈建议

返回参数

放在HTTP Body中,采用Json格式,具体参数如下:

返回结果参数名参数类型参数说明备注
requestIdstring本次请求的唯一标识
codeint请求返回码请见表格《code请求返回码》
messagestring请求返回描述,和请求返回码对应请见表格《code请求返回码》
riskLevelstring当前事件的处置建议code为1100时存在此项 PASS:通过 REVIEW:审核 REJECT:拒绝
detailjson object风险详情信息,详情见下文请见《detail结果详情》表 code为1100时存在此项

其中,detail的内容如下:

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识,命中的规则标识
hitsjson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》

| riskType | int | 当前事件的风险类型 | 是对model的标签化描述,暂定6种,后续可能会调整(详见《riskType风险类型列表》) |

其中,hits结果详情的内容如下:

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
riskLevelstring当前事件的处置建议PASS:通过 REVIEW:审核 REJECT:拒绝

riskType风险类型列表如下:

riskTypemessage
0有效新增
100积分墙设备
200虚拟设备
310伪造设备
320篡改设备
330设备农场
400重复安装
410升级安装

code请求返回码列表如下:

codemessage
1100成功
1901QPS超限(当前接口QPS上限值为150)
1902参数不合法
1903服务失败
9100余额不足
9101无权限操作

示例

请求示例

curl -d '{"accessKey":"XXXXXXXXXXXXXXXXXXXX","appId":"XXXXXX","eventId":"activation","data":{"ip":"1.1.1.1","timestamp":1608637021094,"advertisingId":"imei","apputm":"推广渠道","deviceId":"xxxxxx","os":"android","appVersion":"1.1.1.1","extra":{"自定义数据":"客户自有数据"}}' 'http://api-skynet-bj.fengkongcloud.com/v4/event'

返回示例

{
"code": 1100,
"message": "成功",
"requestId": "742379510766099aea31b77fe654270f",
"riskLevel": "REJECT",
"detail": {
"model": "M99020201",
"riskType": 310,
"description": "高风险设备:伪造设备",
"hits": [
{
"model": "M99020201",
"riskLevel": "REJECT",
"description": "高风险设备:伪造设备"
},
{
"description": "升级激活:同一设备升级安装应用",
"model": "M99220215",
"riskLevel": "REJECT"
}
]
}
}

1.3. 结果处理方法#

业务方根据每次请求的riskType返回结果,实时生成渠道激活的业务报表。

在线咨询