captcha

模块概述:

360天御安全验证码SDK


开通流程:

  1. 注册账号

    • 加固保官网提供验证服务的注册和开通入口。新用户需注册360用户账号,登录加固保官网管理中心;已使用加固保服务的老用户直接登录。https://jiagu.360.cn/#/global/details/safe
  2. 开通服务

    • 联系加固保官方客服,开通验证码服务授权。集成前在管理中心添加需集成验证码SDK的应用信息,并通过管理中心获取服务appid及通信secretkey。
  3. 客户端集成

    • 在APICloud平台,创建应用后添加captcha模块,按模块文档调用接口即可集成。可使用自定义loader或云编译测试包测试。
  4. 服务端接入

    • 业务服务端根据服务端接口说明,接入二次验证服务。用户可根据需求选择自定义验证码背景图和LOGO

模块使用攻略

  • 使用此模块之前建议先配置 config.xml 文件,配置完毕,提交代码,需通过云端编译生效,配置方法如下:

Android

<widget id="A123456789"  version="0.0.1">
    ......
    <meta-data name="captcha-appid" value="0000000000" />
    .....
</widget>

iOS

<feature name="captcha">
    <param name="captcha-appid" value="0000000000" />
</feature>

API接口

validate

  • 作用:显示验证码

  • validate(callback(ret, err))

  • callback(ret, err)

  • ret:
  • 类型:JSON 对象
  • 内部字段:
// Android
{
    result: "success"      //字符型;验证结果是否正确
    token: "000"           //字符型;返回一个随机token
    msg: "verifysuccess"   //字符型;返回结果信息
}

// iOS
{
    token: "000"           //字符型;返回一个随机Token
}
  • err:
  • 类型:JSON 对象
  • 内部字段:
{
    msg: "605"     //字符型;
                   //错误码:      
}

示例代码

var captchamodule = api.require('captcha');
captchamodule.validate(function(ret, err){
    if(err === ""){
        alert(JSON.stringify(ret));
    }
    else {
        alert(JSON.stringify(err)); 
    }
});

可用性

Android、iOS系统

可提供的1.0.0及更高版本