智能验证码二次验证API文档#


版权所有 翻版必究


二次验证接口#

请求参数#

请求URL:#

集群URL支持产品列表
北京集群http://captcha-s.fengkongcloud.com/ca/v1/sverify二次验证
新加坡集群http://captcha-xjp.fengkongcloud.com/ca/v1/sverify二次验证
佛吉尼亚集群http://captcha-fjny.fengkongcloud.com/ca/v1/sverify二次验证

字符编码格式:#

UTF-8

请求方法:#

POST

建议超时时间:#

1s

请求参数:#

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

请求参数名类型参数说明传入说明规范
accessKeystring接口认证密钥
用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看
必传参数accessKey
datajson_object请求的数据内容必传参数请求的数据内容,最长10MB,详见data参数
其中,data的内容如下:
请求参数名类型参数说明是否必传规范
ridstring滑动验证码请求标识必传参数调用数美sdk获取
ipstringip地址必传参数用户滑动验证码时的客户端公网ipv4地址
tokenIdstring用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。
如无用户uid的场景建议使用唯一的数据标识传值
非必传参数由数字、字母、下划线、短杠组成的长度小于等于64位的字符串
deviceIdstring数美设备标识必传参数数美设备指纹生成的设备唯一标识
expectedModestring验证码的类型建议参数验证码类型包括:
- slide: 滑动验证码
- select: 文字点选验证码
- icon_select: 图标点选验证码
- seq_select: 语序点选验证码
- spatial_select:空间推理验证码
expectedAppIdstring预期验证码参与验证的应用标识(AppId:该标识为在数美创建的应用标识)建议参数回传预期需要校验验证码验证结果的应用标识

返回结果#

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

参数名称参数类型参数说明是否必返规范
codeint返回码1100:成功
1901:QPS超限
1902:参数不合法
1903:服务失败
9101:无权限操作

除message和requestId之外的字段,只有当code为1100时才会存在
requestIdstring请求标识请求唯一标识,用于排查问题和后续效果优化,强烈建议保存
messagestring返回码描述和code对应:成功QPS超限参数不合法服务失败余额不足无权限操作
riskLevelstring处置建议可能返回值:
PASS:正常,建议直接放行
REJECT:违规,建议直接拦截
scoreint当前事件的风险评分,分数越高,风险越大[0, 1000]
detailjson_object风险详情信息详见detail结果详情
其中,detail结果详情如下:
参数名称参数类型参数说明是否必返规范
descriptionstring当前事件的风险描述调用数美sdk获取
descriptionV2string当前事件的风险描述用户滑动验证码时的客户端公网ipv4地址
modelstring规则标识,命中的最高优先级规则标识由数字、字母、下划线、短杠组成的长度小于等于64位的字符串

示例:#

请求示例:#

{
"accessKey":"****************",
"data":{
"expectedMode": "slide",
"expectedAppId":"AppID",
"rid":"************",
"ip":"111.85.43.52"
}
}

同步返回示例:#

{
"code":1100,
"detail":{
"description":"正常",
"model":"M1000",
},
"message":"成功",
"requestId":"585f346fd836f98403d72239f612b13a",
"riskLevel":"PASS",
}

在线咨询