数美天网-注册登录保护#


版权所有 翻版必究


注册登录保护

注册登录保护#

事件接口#

请求URL:#

集群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天网风险识别
欧洲(法兰克福)http://api-skynet-eur.fengkongcloud.com/v4/event天网风险识别

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

请求body = 通用请求参数 + 事件特有参数 (放在data字段下)

通用的请求参数:#

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

参数名称类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
appIdstring应用ID,用于区分相同公司的不同应用必传参数该参数传递值可与数美协商
eventIdstring事件ID,用于标识事件类型。必传参数不同的事件对应不同的策略,不同的事件输入参数可能会有细微的差别,请对应按照各事件详细传参说明
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
参数名称类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值不能同时为空该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致
isTokenSeperateint是否区分账号体系 同公司不同app接入,未统一账号体系,不同app,不同用户出现相同账号需要区分账号体系,0,不区分,1,区分。必传参数默认为0,如传为1,则token会自动处理为appid_token用以区分不同账号体系
ipstring当前业务事件发生时的客户端公网ipv4地址必传字段非内网ip
timestampint64当前业务事件发生时的时间戳,单位为毫秒(ms)必传字段
deviceIdstring数美设备指纹标识,由数美SDK生成强烈建议数美设备指纹标识,用于用户行为分析。
注:
1. 接入数美SDK前的版本,无法获取到deviceId的情况下,deviceId传空“”即可;
2. 直接传输getDeviceId获取到的原始字段,不需要解密
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
activityIdstring营销活动id强烈建议建议传入对应营销活动标识id
userAgentstring用户代理强烈建议
phonestring手机号强烈建议
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
phoneMd5string手机号的phoneMd5加密串建议
phoneSha256string手机号的Sha256加密串建议
rolestring角色强烈建议可选值(强校验取值只能为空、ADMINHOST);HOST代表主播,针对主播,将会放开多开、PC模拟器规则以及关联频度策略阈值,以保证主播的正常体验和使用。
levelint用户等级,针对不同等级的用户可配置不同拦截策略强烈建议可选值:0,1,2,3,4分别对应:
0:最低级用户,典型如新注册、完全不活跃或等级为0的用户等
1:较低级用户,典型如低活跃或低等级用户等
2:中等级用户,典型如具备一定活跃或等级中等的用户等
3:较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等
vdatajson微行为数据传入字段建议
extrajson用户自定义数据建议如无必要,不传
passThroughjson用户自定义透传字段建议如无必要,不传

返回结果#

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

参数名称类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
riskevelstring当前事件的处置建议PASS:通过
REVIEW:审核
REJECT:拒绝
VERIFY:验证
detailjson_object风险详情信息,详情见下文请见《detail结果详情》表
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在服务开通时返回

其中

1)detail结果的详情内容

返回结果参数名参数类型参数说明规范
descriptionstring当前事件的风险描述
modelstring规则标识,命中的最高优先级规则标识
hitsJson array事件命中的所有规则标识hits中每个字段都是一个object,详见《hits结果详情信息》
ip_countrystringip归属地国家
ip_provincestringip归属地省份
ip_citystringip归属地城市
verifyTypestring当处置建议为VERIFY时,返回verifyTypeUPSMS:上行短信验证码
DOWNSMS:下行短信验证码
CAPTCHA:验证码(点选或滑动等)
SEQUENCE:语序验证(点选或输入)
SPATIAL:空间逻辑推理
FACE:人脸检测
DELAY:延时交易

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

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

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

事件列表#

行业场景事件eventId规范
通用通用注册register参数详情
通用通用登录login参数详情
通用通用更改密码changePassword参数详情
通用通用重置密码resetPassword参数详情
通用通用更换绑定手机号changePhone参数详情
通用通用换绑手机号结果changePhoneResult参数详情
通用通用更新账号信息accountUpdate参数详情
通用通用预注册preRegister参数详情
通用通用预登陆preLogin参数详情
通用通用账户信息更新profile参数详情
通用通用游客注册preRegister参数详情
通用通用短信通道保护sms参数详情

事件详细API#

注册事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
typestring注册方式: 包括手机号码一键注册、手机号验证码注册、第三方授权、用户名密码注册必传字段可选值:
phoneOnePass:手机号一键注册、手机号验证码注册
signupPlatform、第三方授权
userPassword用户名密码注册
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
isPhoneExistint该手机号是否已经被注册强烈建议可选值:01若注册方式为手机号注册,且该手机号已经被注册过,则传入1,否则传入0.
guestIdstring游客账号强烈建议在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。
nickNamestring用户账户昵称建议
clickIdstring点击id强烈建议(渠道假量场景,关联渠道点击事件使用)
腾讯平台:传入点击回调中的click_id即可
巨量平台:传入点击回调中的CALLBACK_PARAM即可
signupPlatformstring第三方注册平台,如果本平台直接注册,可以不传建议可选值:qq、weibo、weixin、alipay、taobao、facebook、twitter
emailstring注册使用邮箱建议
sexstring用户性别,没有则不传建议可选值:male,female
isSignupPlatformPhoneint该手机号是否是第三方授权平台手机号建议可选值:01若手机号为第三方授权平台绑定的手机号,则传入1,否则传入0.

登录事件 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
typestring登录方式,包括:本机号码一键登录、手机号密码登录、手机号验证码登录、用户名密码登录、生物识别(指纹、人脸、声音锁)登录必传字段可选值:
fastLogin:快速登录
phoneOneLogin:本机号码一键登录
phonePassword:手机号密码登录
phoneMessage:手机号验证码登录signupPlatform:第三方授权登录
userPassword:用户名密码登录
biometric:生物识别
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
roleIdstring当前业务登录用户角色,游戏行业特殊字段强烈建议
validint用户名密码验证结果建议可选值:
1:成功
0:失败

更改密码 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
typestring在注册流程之外,设置密码的类型必传参数可选值:initialPassword、resetPassword
exPasswordstring加密后的更改前用户密码必传参数可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一且一致的。
newPasswordstring加密后的更改后用户密码必传参数可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一且一致的。

重置密码 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
newPasswordstring加密后的更改后用户密码必传参数可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。

更换绑定手机号 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
newPasswordstring加密后的更改后用户密码必传参数可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。

换绑手机号结果 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
exPhonestring换绑手机号前,用户手机号的MD5加密字符串必传参数MD5加密字符串格式为32位小写
updateResultint换绑手机号的处置结果必传参数可选值:0或者1换绑成功传入1,换绑失败传入0

更新账号信息 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
exNickNamestring修改前昵称修改后传
newNickNamestring修改后昵称修改后传
exGenderstring修改前性别修改后传
newGenderstring修改后性别修改后传
exBirthdaystring修改前生日修改后传
newBirthdaystring修改后生日修改后传
exPhonestring修改前电话号码修改后传
newPhonestring修改后手机号修改后传
exEmailstring修改前邮箱修改后传
newMailstring修改后邮箱修改后传

预注册 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
tokenIdstring当前业务新注册的用户账号必传字段注册事件需要在生成用户账号ID后调用,每个用户账号ID是唯一的,且与其它数美接口tokenId保持一致性,长度限制在64个字符以内。
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
isPhoneExistint该手机号是否已经被注册强烈建议可选值:0,1若注册方式为手机号注册,且该手机号已经被注册过,则传入1,否则传入0.
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
guestIdstring游客账号强烈建议在游客账号绑定成真实账号时,tokenId传入真实账号,guestId传入游客账号,长度限制在64个字符以内。
phonestring用户注册使用的手机号或者该手机号MD5加密字符串强烈建议中国大陆区手机号请填写11位数字例如:13800138000MD5加密字符串格式为32位小写
countryCodestring手机用户的国家代码强烈建议中国大陆区手机号填写0086非中国大陆区手机号填写国家代码例如:美国填写0001、安道尔0376、巴哈马1242
nickNamestring用户账户昵称建议
signupPlatformstring第三方注册平台,如果本平台直接注册,可以不传建议可选值:qq、weibo、weixin、alipay、taobao、facebook、twitter、other
emailstring注册使用邮箱建议
sexstring用户性别,没有则不传建议可选值:male,female

预登陆 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
hashPasswordstring加密后的用户密码强烈建议可选择任意一种加密方式进行加密,但必须确保同一密码加密后是唯一的且一致的。
subTokenIdstring账号的子账号强烈建议某些特殊的场景主账号有多个子账号(游戏场景不同区服)
validint用户名密码验证结果建议可选值:
1:成功
0:失败

账户信息更新 #

参数名称类型参数说明是否必传规范
基础参数需要满足基础参数的配置要求
prcidstring身份证ID建议将用户输入的身份证ID以md5加密,身份证ID为以下内容之一:身份证号码;港澳居民身份证号码;台湾居民身份证号码;护照号码;
emailstring邮箱建议
nickNamestring用户账户昵称建议
sexstring用户性别,没有则不传建议可选值:male,female

示例:#

请求示例:#

{
"accessKey": "XXXXXXXXXX",
"appId": "qiuqiu",
"eventId": "profile",
"data": {
"tokenId": "1749068313",
"ip": "2409:8930:c2a0:1e7a:1:2:c4e6:84b6",
"timestamp": 1652062699989,
"phone": "13856739921",
"deviceId": "20220509101136d35ba464ae548a4dcb93b164044f5cb5012cec28e7b95ce7"
}
}

同步返回示例:#

{
"detail": {
"model": "M1000",
"ip_city": "亳州",
"hits": [
],
"token": {
"groupId": "",
"groupSize": 0,
"riskGrade": "",
"riskReason": "",
"riskType": "",
"score": 0
},
"ip_country": "中国",
"ip_province": "安徽",
"description": "正常"
},
"code": 1100,
"message": "成功",
"requestId": "5ff11f356f4bfef67909c0389991c976",
"riskLevel": "PASS",
"score": 0
}

账号查询接口#

请求URL:#

集群URL支持产品列表
北京集群http://api-tianxiang-bj.fengkongcloud.com/tianxiang/v4风险查询
新加坡集群http://api-tianxiang-xjp.fengkongcloud.com/tianxiang/v4风险查询
法兰克福集群http://api-tianxiang-eur.fengkongcloud.com/tianxiang/v4风险查询
弗吉尼亚集群http://api-tianxiang-fjny.fengkongcloud.com/tianxiang/v4风险查询

请求方法:#

POST

字符编码:#

UTF-8

建议超时时间:#

1s

请求参数:#

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

请求参数名类型参数说明是否必传规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数数美分配
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值不能为空该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致

返回结果#

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

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
1911:图片下载失败
9101:无权限操作
3000:运营商错误
除message和requestId之外的字段,只有当code为1100时才会存在
messagestring返回码描述和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
tokenLabelsjson_object账号标签信息见下面详情内容,仅在tokenId传入且服务开通时返回
tokenProfileLabelsjson_array账号属性标签见下面详情内容,仅在tokenId传入且服务开通时返回
tokenRiskLabelsjson_array账号风险标签见下面详情内容,仅在tokenId传入且服务开通时返回

其中

1)tokenLabels的详情内容

返回结果参数名参数类型参数说明规范
machine_account_riskjson_object机器控制相关风险
UGC_account_riskjson_objectUGC内容相关风险
scene_account_riskjson_object场景账号风险特殊场景才可取到,如航司等

machine_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_machine_control_tokenidint机器账号0:非机器控制账号1:机器控制账号
b_machine_control_tokenid_last_tsint机器账号时间
b_offer_wall_tokenidint积分墙账号0:非积分墙账号1:积分墙账号
b_offer_wall_tokenid_last_tsint积分墙账号时间

UGC_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
b_politics_risk_tokenidint涉政风险0:暂未发现涉政风险1:存在涉政风险
b_politics_risk_tokenid_last_tsint涉政风险时间
b_sexy_risk_tokenidint色情风险0:暂未发现色情风险1:存在色情风险
b_sexy_risk_tokenid_last_tsint色情风险时间
b_advertise_risk_tokenidint广告风险0:暂未发现广告风险1:存在广告风险
b_advertise_risk_tokenid_last_tsint广告风险时间

scene_account_risk的详情内容如下:

返回结果参数名参数类型参数说明规范
i_tout_risk_tokenidint航司占座账号0:非航司占座账号1:航司占座账号
i_tout_risk_tokenid_last_tsint航司占座时间

其中标签类返回字段

1)tokenProfileLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号属性标签的一级标签。
label2string二级标签展示账号属性标签的二级标签。
label3string三级标签展示账号属性标签的三级标签。
descriptionstring风险描述展示账号属性标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

2)tokenRiskLabels的详情内容

返回结果参数名参数类型参数说明规范
label1string一级标签展示账号风险标签的一级标签。
label2string二级标签展示账号风险标签的二级标签。
label3string三级标签展示账号风险标签的三级标签。
descriptionstring风险描述展示账号风险标签的中文描述。
timestampint64最近一次命中策略的时间最近一次命中策略的时间
detailjson_object证据描述证据细节

示例:#

请求示例:#

{
"accessKey": "xxxxxxxxxxxxxxxxxxxxxxxxx",
"data": {
"tokenId": "ceshitokenId"
}
}

同步返回示例:#

{
"code": 1100,
"message": "成功",
"profileExist": 1,
"requestId": "7a5445716f0581c2ab1d381a6af4d1b8",
"tokenLabels": {
"machine_account_risk": {
"b_machine_control_tokenid": 1,
"b_machine_control_tokenid_last_ts": 1587711321232,
"b_offer_wall_tokenid": 1,
"b_offer_wall_tokenid_last_ts": 1587711321232
},
"UGC_account_risk": {
"b_politics_risk_tokenid": 1,
"b_politics_risk_tokenid_last_ts": 1587711321232,
"b_sexy_risk_tokenid": 1,
"b_sexy_risk_tokenid_last_ts": 1587711321232,
"b_advertise_risk_tokenid": 1,
"b_advertise_risk_tokenid_last_ts": 1587711321232
},
"scene_account_risk": {
"i_tout_risk_tokenid": 1,
"i_tout_risk_tokenid_last_ts": 1587711321232
},
"account_active_info": {
"i_tokenid_first_active_timestamp": 1587711321232,
"i_tokenid_active_days_7d": 5,
"i_tokenid_active_days_4w": 5
},
"account_freq_info": {
"i_tokenid_login_cnt_1d": 5,
"i_tokenid_login_cnt_7d": 5
},
"account_relate_info": {
"i_tokenid_relate_smid_cnt_1d": 5,
"i_tokenid_relate_smid_cnt_7d": 5,
"i_tokenid_relate_ip_city_cnt_1d": 5,
"i_tokenid_relate_ip_city_cnt_7d": 5
},
"account_common_info": {
"s_tokenid_relate_smid_info_map_4w": [
{
"smid": "xxxx1",
"days": "3"
},
{
"smid": "xxxx2",
"days": "5"
},
{
"smid": "xxxx3",
"days": "10"
}
],
"s_tokenid_relate_ip_city_info_map_4w": [
{
"city": "北京",
"days": "3"
},
{
"city": "长沙",
"days": "5"
},
{
"city": "武汉",
"days": "10"
}
]
}
},
"tokenProfileLabels": [
{
"label1": "age_gender",
"lable2": "token_age",
"label3": "minor_token",
"description": "年龄性别:年龄:未成年人",
"timestamp": 1634732525000,
"detail": {
}
}
],
"tokenRiskLabels": [
{
"label1": "risk_device_token",
"label2": "b_cloud_token_device",
"label3": "b_cloud_token_device",
"description": "风险设备账号:云手机账号:云手机账号",
"timestamp": 1634732525000,
"detail": {
}
},
{
"label1": "risk_device_token",
"label2": "b_hook_token",
"label3": "b_hook_token",
"description": "风险设备账号:hook设备:hook设备",
"timestamp": 1634732525000,
"detail": {
}
}
]
}

在线咨询