1. 注册#

1.1. 调用时机#

当前业务新用户注册流程中,在生成用户账号id之后,实时调用本接口,调用者可根据接口的返回参数进行相应的业务处理。

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,用于标识事件类型。必传参数register
datajson object本次请求相关信息,详情见下文必传参数请见表格《data请求相关信息》

其中,data的内容如下:

请求参数名类型参数说明传入说明备注
tokenIdstring当前业务新注册的用户账号必传字段注册事件需要在生成用户账号ID后调用,每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性,长度限制在64个字符以内。
ipstring当前业务事件发生时的客户端公网ipv4地址必传字段
timestampint64当前业务事件发生时的时间戳,单位为毫秒(ms)必传字段
isTokenSeperateInt是否区分账号体系 同公司不同app接入,需要区分账号体系,0,不区分,1,区分。必传参数默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系
deviceIdstring数美设备指纹标识,由数美SDK生成强烈建议
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
isPhoneExistint该手机号是否已经被注册强烈建议可选值:0,1 若注册方式为手机号注册,且该手机号已经被注册过,则传入1,否则传入0.
guestIdstring游客账号强烈建议在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。
phonestring用户注册使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字 例如:13800138000 MD5加密字符串格式为32位小写
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086 非中国大陆区手机号填写国家代码 例如:美国填写0001、安道尔0376、巴哈马1242
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。
nickNamestring用户账户昵称建议
gpsLocationjson object事件发生时的位置信息,详情见下文建议详见下文 gpsLocation的内容
signupPlatformstring第三方注册平台,如果本平台直接注册,可以不传建议可选值: qq、weibo、weixin、alipay、taobao、facebook、twitter、其他
emailstring注册使用邮箱建议
sexstring用户性别,没有则不传建议可选值:male,female
clickIdstring点击id强烈建议(渠道假量场景,关联渠道点击事件使用)腾讯平台:传入点击回调中的click_id即可;巨量平台:传入点击回调中的CALLBACK_PARAM即可
extrajson_object用户自定义数据如无必要,不传

gpsLocation的内容如下:

请求参数名类型参数说明传入说明备注
gpsLongitudefloat64事件发生时的gps的经度信息建议
gpsLatitudefloat64事件发生时的gps的维度信息建议

返回参数

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

返回结果参数名参数类型参数说明备注
requestIdstring本次请求的唯一标识
codeint请求返回码请见表格《code请求返回码》
messagestring请求返回描述,和请求返回码对应请见表格《code请求返回码》
riskLevelstring当前事件的处置建议PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易
detailjson object风险详情信息,详情见下文请见《detail结果详情》表

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

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
hitsjson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》
machineAccoun tRiskjson_object机器控制账号相关风险
fakePhoneRiskjson_object虚假手机号相关风险
fakeDeviceRiskjson_object虚假设备相关风险

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

返回结果参数名参数类型参数说明备注
tokenSampleLastTsint64账号打黑时间
tokenSampleDescstring账号打黑详情

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

返回结果参数名参数类型参数说明备注
phoneSampleLastTsint64手机号打黑时间
phoneSampleDescstring手机号打黑详情

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

返回结果参数名参数类型参数说明备注
smidSampleLastTsint64设备打黑时间
smidSampleDescstring设备打黑详情

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

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识
riskLevelstring当前事件的处置建议PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易

code请求返回码列表如下:

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

1.3. 结果使用方法#

直接根据接口返回的riskLevel进行处理,处理方法如下:

REJECT:拒绝注册,或者结合图片滑动验证码/人脸识别/短信上行验证码等进行二次验证

REVIEW:该用户为可疑用户,结合图片滑动验证码/人脸识别/短信上行验证码 等进行二次验证

PASS:正常注册

VERIFY:做二次验证

2. 登录#

2.1. 调用时机#

当前业务中登录请求验证完成后调用,在验证成功和验证失败的时候都需要进行调用。

2.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,用于标识事件类型。必传参数login
datajson object本次请求相关信息,详情见下文必传参数请见表格《data请求相关信息》

其中,data的内容如下:

请求参数名类型参数说明传入说明备注
tokenIdstring当前业务登录用户账号必传参数每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性,长度限制在64个字符以内。
ipstring事件发生时的客户端公网ipv4地址必传参数
timestampint64事件发生时的时间戳,单位为毫秒(ms)必传参数
deviceIdstring数美设备指纹标识强烈建议
isTokenSeperateInt是否区分账号体系 同公司不同app接入,需要区分账号体系,0,不区分,1,区分。必传参数默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
phonestring用户登录使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字 例如:13800138000 MD5加密字符串格式为32位小写
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086 非中国大陆区手机号填写国家代码 例如:美国填写0001、安道尔0376、巴哈马1242
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。
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值: 0,1,2,3,4 分别对应: 0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等 1:较低级用户,典型如低活跃或低等级用户等 2:中等级用户,典型如具备一定活跃或等级中等的用户等 3:较高级用户,典型如高活跃或高等级用户等 4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
validint用户名密码验证结果建议可选值: 1: 成功 0: 失败
clickIdstring点击id强烈建议(渠道假量场景,关联渠道点击事件使用)腾讯平台:传入点击回调中的click_id即可;巨量平台:传入点击回调中的CALLBACK_PARAM即可
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
gpsLocationjson_object事件发生时的位置信息,详情见下文建议详见下文gpsLocation的内容

返回参数

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

返回结果参数名参数类型参数说明备注
requestIdstring本次请求的唯一标识
codeint请求返回码请见表格《code请求返回码》
messagestring请求返回描述,和请求返回码对应请见表格《code请求返回码》
riskLevelstring当前事件的处置建议PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易
detailjson object风险详情信息,详情见下文请见《detail结果详情》表

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

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
hitsjson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》
machineAccoun tRiskjson_object机器控制账号相关风险
fakePhoneRiskjson_object虚假手机号相关风险
fakeDeviceRiskjson_object虚假设备相关风险

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

返回结果参数名参数类型参数说明备注
tokenSampleLastTsint64账号打黑时间
tokenSampleDescstring账号打黑详情

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

返回结果参数名参数类型参数说明备注
phoneSampleLastTsint64手机号打黑时间
phoneSampleDescstring手机号打黑详情

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

返回结果参数名参数类型参数说明备注
smidSampleLastTsint64设备打黑时间
smidSampleDescstring设备打黑详情

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

返回结果参数名参数类型参数说明备注
descriptionstring当前事件的风险描述
modelstring规则标识
riskLevelstring当前事件的处置建议PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易

code请求返回码列表如下:

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

2.3. 结果使用方法#

直接根据接口返回的riskLevel进行处理,处理方法如下:

REJECT:拒绝登录,或者正常登录同时标记该用户,限制该用户在App内的行为。

REVIEW:该用户为可疑用户,建议结合图片滑动验证码/人脸识别/短信上行验证码/短信下行验证码等进行二次验证

PASS:正常登录

VERIFY:做二次验证