#
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格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
accessKey | string | 用于权限认证的访问密钥,由数美提供 | 必传参数 | 数美分配 |
appId | string | 应用ID,用于区分相同公司的不同应用 | 必传参数 | 该参数传递值可与数美协商 |
eventId | string | 事件ID,用于标识事件类型。 | 必传参数 | register |
data | json object | 本次请求相关信息,详情见下文 | 必传参数 | 请见表格《data请求相关信息》 |
其中,data的内容如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
tokenId | string | 当前业务新注册的用户账号 | 必传字段 | 注册事件需要在生成用户账号ID后调用,每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性,长度限制在64个字符以内。 |
ip | string | 当前业务事件发生时的客户端公网ipv4地址 | 必传字段 | |
timestamp | int64 | 当前业务事件发生时的时间戳,单位为毫秒(ms) | 必传字段 | |
isTokenSeperate | Int | 是否区分账号体系 同公司不同app接入,需要区分账号体系,0,不区分,1,区分。 | 必传参数 | 默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系 |
deviceId | string | 数美设备指纹标识,由数美SDK生成 | 强烈建议 | |
hashPassword | string | 加密后的用户密码 | 强烈建议 | 可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。 |
isPhoneExist | int | 该手机号是否已经被注册 | 强烈建议 | 可选值:0,1 若注册方式为手机号注册,且该手机号已经被注册过,则传入1,否则传入0. |
guestId | string | 游客账号 | 强烈建议 | 在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。 |
phone | string | 用户注册使用的手机号或者该手机号MD5加密字符串 | 强烈建议 | 中国大陆区手机号请填写11位数字 例如:13800138000 MD5加密字符串格式为32位小写 |
countryCode | string | 手机用户的国家代码 | 强烈建议 | 中国大陆区手机号填写0086 非中国大陆区手机号填写国家代码 例如:美国填写0001、安道尔0376、巴哈马1242 |
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。 |
nickName | string | 用户账户昵称 | 建议 | |
gpsLocation | json object | 事件发生时的位置信息,详情见下文 | 建议 | 详见下文 gpsLocation的内容 |
signupPlatform | string | 第三方注册平台,如果本平台直接注册,可以不传 | 建议 | 可选值: qq、weibo、weixin、alipay、taobao、facebook、twitter、其他 |
string | 注册使用邮箱 | 建议 | ||
sex | string | 用户性别,没有则不传 | 建议 | 可选值:male,female |
clickId | string | 点击id | 强烈建议 | (渠道假量场景,关联渠道点击事件使用)腾讯平台:传入点击回调中的click_id即可;巨量平台:传入点击回调中的CALLBACK_PARAM即可 |
extra | json_object | 用户自定义数据 | 如无必要,不传 |
gpsLocation的内容如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
gpsLongitude | float64 | 事件发生时的gps的经度信息 | 建议 | |
gpsLatitude | float64 | 事件发生时的gps的维度信息 | 建议 |
返回参数
放在HTTP Body中,采用Json格式,具体参数如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
requestId | string | 本次请求的唯一标识 | |
code | int | 请求返回码 | 请见表格《code请求返回码》 |
message | string | 请求返回描述,和请求返回码对应 | 请见表格《code请求返回码》 |
riskLevel | string | 当前事件的处置建议 | PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证 |
verifyType | string | 当处置建议为VERIFY时,返回verifyType | UPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易 |
detail | json object | 风险详情信息,详情见下文 | 请见《detail结果详情》表 |
其中,detail结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的最高优先级规则标识 | |
hits | json array | 事件命中的所有规则标识 | hits中每个字段都是一个object,详见《hits结果详情信息》 |
machineAccoun tRisk | json_object | 机器控制账号相关风险 | |
fakePhoneRisk | json_object | 虚假手机号相关风险 | |
fakeDeviceRisk | json_object | 虚假设备相关风险 |
其中,machineAccountRisk结果详情的内容如下 :
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
tokenSampleLastTs | int64 | 账号打黑时间 | |
tokenSampleDesc | string | 账号打黑详情 |
其中,fakePhoneRisk结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
phoneSampleLastTs | int64 | 手机号打黑时间 | |
phoneSampleDesc | string | 手机号打黑详情 |
其中,fakeDeviceRisk结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
smidSampleLastTs | int64 | 设备打黑时间 | |
smidSampleDesc | string | 设备打黑详情 |
其中,hits结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识 | |
riskLevel | string | 当前事件的处置建议 | PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证 |
verifyType | string | 当处置建议为VERIFY时,返回verifyType | UPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易 |
code请求返回码列表如下:
code | message |
---|---|
1100 | 成功 |
1901 | QPS超限(当前接口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格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
accessKey | string | 用于权限认证的访问密钥,由数美提供 | 必传参数 | 数美分配 |
appId | string | 应用ID,用于区分相同公司的不同应用 | 必传参数 | 该参数传递值可与数美协商 |
eventId | string | 事件ID,用于标识事件类型。 | 必传参数 | login |
data | json object | 本次请求相关信息,详情见下文 | 必传参数 | 请见表格《data请求相关信息》 |
其中,data的内容如下:
请求参数名 | 类型 | 参数说明 | 传入说明 | 备注 |
---|---|---|---|---|
tokenId | string | 当前业务登录用户账号 | 必传参数 | 每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性,长度限制在64个字符以内。 |
ip | string | 事件发生时的客户端公网ipv4地址 | 必传参数 | |
timestamp | int64 | 事件发生时的时间戳,单位为毫秒(ms) | 必传参数 | |
deviceId | string | 数美设备指纹标识 | 强烈建议 | |
isTokenSeperate | Int | 是否区分账号体系 同公司不同app接入,需要区分账号体系,0,不区分,1,区分。 | 必传参数 | 默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系 |
hashPassword | string | 加密后的用户密码 | 强烈建议 | 可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。 |
subTokenId | string | 账号的子账号 | 强烈建议 | 某些特殊的场景主账号有多个子账号(游戏场景不同区服) |
phone | string | 用户登录使用的手机号或者该手机号MD5加密字符串 | 强烈建议 | 中国大陆区手机号请填写11位数字 例如:13800138000 MD5加密字符串格式为32位小写 |
countryCode | string | 手机用户的国家代码 | 强烈建议 | 中国大陆区手机号填写0086 非中国大陆区手机号填写国家代码 例如:美国填写0001、安道尔0376、巴哈马1242 |
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。 |
level | int | 用户等级,针对不同等级的用户可配置不同拦截策略 | 强烈建议 | 可选值: 0,1,2,3,4 分别对应: 0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等 1:较低级用户,典型如低活跃或低等级用户等 2:中等级用户,典型如具备一定活跃或等级中等的用户等 3:较高级用户,典型如高活跃或高等级用户等 4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等 |
valid | int | 用户名密码验证结果 | 建议 | 可选值: 1: 成功 0: 失败 |
clickId | string | 点击id | 强烈建议 | (渠道假量场景,关联渠道点击事件使用)腾讯平台:传入点击回调中的click_id即可;巨量平台:传入点击回调中的CALLBACK_PARAM即可 |
roleId | string | 当前业务登录用户角色,游戏行业特殊字段 | 强烈建议 | |
gpsLocation | json_object | 事件发生时的位置信息,详情见下文 | 建议 | 详见下文gpsLocation的内容 |
返回参数:
放在HTTP Body中,采用Json格式,具体参数如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
requestId | string | 本次请求的唯一标识 | |
code | int | 请求返回码 | 请见表格《code请求返回码》 |
message | string | 请求返回描述,和请求返回码对应 | 请见表格《code请求返回码》 |
riskLevel | string | 当前事件的处置建议 | PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证 |
verifyType | string | 当处置建议为VERIFY时,返回verifyType | UPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易 |
detail | json object | 风险详情信息,详情见下文 | 请见《detail结果详情》表 |
其中,detail结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的最高优先级规则标识 | |
hits | json array | 事件命中的所有规则标识 | hits中每个字段都是一个object,详见《hits结果详情信息》 |
machineAccoun tRisk | json_object | 机器控制账号相关风险 | |
fakePhoneRisk | json_object | 虚假手机号相关风险 | |
fakeDeviceRisk | json_object | 虚假设备相关风险 |
其中,machineAccountRisk结果详情的内容如下 :
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
tokenSampleLastTs | int64 | 账号打黑时间 | |
tokenSampleDesc | string | 账号打黑详情 |
其中,fakePhoneRisk结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
phoneSampleLastTs | int64 | 手机号打黑时间 | |
phoneSampleDesc | string | 手机号打黑详情 |
其中,fakeDeviceRisk结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
smidSampleLastTs | int64 | 设备打黑时间 | |
smidSampleDesc | string | 设备打黑详情 |
其中,hits结果详情的内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 备注 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识 | |
riskLevel | string | 当前事件的处置建议 | PASS:通过 REVIEW:审核 REJECT:拒绝 VERIFY:验证 |
verifyType | string | 当处置建议为VERIFY时,返回verifyType | UPSMS:上行短信验证码 DOWNSMS:下行短信验证码 CAPTCHA:验证码(点选或滑动等) SEQUENCE:语序验证(点选或输入) SPATIAL:空间逻辑推理 FACE:人脸检测 DELAY:延时交易 |
code请求返回码列表如下:
code | message |
---|---|
1100 | 成功 |
1901 | QPS超限(当前接口QPS上限值为50) |
1902 | 参数不合法 |
1903 | 服务失败 |
9100 | 余额不足 |
9101 | 无权限操作 |
#
2.3. 结果使用方法直接根据接口返回的riskLevel进行处理,处理方法如下:
REJECT:拒绝登录,或者正常登录同时标记该用户,限制该用户在App内的行为。
REVIEW:该用户为可疑用户,建议结合图片滑动验证码/人脸识别/短信上行验证码/短信下行验证码等进行二次验证
PASS:正常登录
VERIFY:做二次验证