dxCaptcha

init

config

initTokenConfig

open

reload

close

概述

dxCaptcha封装了顶象智能无感验证，支持私有化部署。顶象智能无感验证结合了设备指纹、行为特征、访问频率、地理位置等多项技术，有效的拦截恶意登录、批量注册，阻断机器操作，拦截非正常用户，较传统验证码相比，用户无需再经过思考或输入操作，只需轻轻一滑即可进行验证。

**使用本插件前需要先去顶象官方申请应用，替换相关资源包，上传自定义插件。

android配置：

(1) 下载 dxCaptchaAppendix插件zip包并解压(解压后会看到一个dxCaptchaAppendix文件夹) (2) 从顶象后台下载sdk依赖，将dxCaptchaAppendix根目录下的aar替换成自己下载的aar (3)将下载的文件中areambi文件夹下的直接替换进target根目录下，arm64-v8a、armeabi-v7a同步替换掉 (4)将sourcem目录下的assets和jar替换成自己下载的asserts和jar包 (5)最后将dxCaptchaAppendix压缩为zip，上传自定义插件打包即可使用

init

初始化

init({params})

params

appId:

  • 类型：字符串类型
  • 描述：（必填）顶象官方无感认证应用管理处获取

示例代码

var dxCaptcha = api.require('dxCaptcha');
    dxCaptcha.init({
    appId:""
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

config

自定义配置

config({params})

params

bgColor:

  • 类型：字符串类型
  • 描述：（可选项）弹窗的背景色
  • 默认：#FFFFFF

language:

  • 类型：字符串类型
  • 描述：（可选项）语言，可选值cn:中文、en：英文
  • 默认：cn

cacheStorage:

  • 类型：布尔类型
  • 描述：（可选项）是否开启无感认证，默认开启，iOS不支持
  • 默认：true

loading:

  • 类型：字符串类型
  • 描述：（可选项）加载中的提示语

smartChecking:

  • 类型：字符串类型
  • 描述：（可选项）智能检测的提示语

verifySuccess:

  • 类型：字符串类型
  • 描述：（可选项）验证成功的提示语

verifyFail:

  • 类型：字符串类型
  • 描述：（可选项）验证失败的提示语

isPrivate:

  • 类型：布尔类型
  • 描述：（可选项）是否是私有化部署,私有化部署配置参数需要联系顶象官方确认
  • 默认：false

apiServer:

  • 类型：字符串类型
  • 描述：（可选项）私有服务器地址，私有化必填

logoServer:

  • 类型：字符串类型
  • 描述：（可选项）自定义无感验证logo服务器地址，私有化必填

uaJs:

  • 类型：字符串类型
  • 描述：（可选项）自定义ua脚本地址，私有化必填

capJs:

  • 类型：字符串类型
  • 描述：（可选项）自定义无感验证js地址，私有化必填

keyURL:

  • 类型：字符串类型
  • 描述：（可选项）自定义设备指纹地址，私有化必填

keyBackup:

  • 类型：字符串类型
  • 描述：（可选项）设备指纹数据线上备份，私有化必填
  • 默认：true

示例代码

var dxCaptcha = api.require('dxCaptcha');
dxCaptcha.config({
    loading:"正在加载...",
    smartChecking:"智能检测中..."
    verifySuccess:"验证成功",
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

initTokenConfig

主要用于poc测试，每次请求不走本地缓存，仅支持Android

initTokenConfig({params})

params

isClearToken:

  • 类型：布尔类型
  • 描述：是否清除本地缓存
  • 默认：true

示例代码

var dxCaptcha = api.require('dxCaptcha');
dxCaptcha.initTokenConfig();

可用性

Android系统

可提供的1.0.0及更高版本

open

打开验证窗口

open({params}, callback(ret))

params

rect：

  • 类型：JSON 对象
  • 描述：（可选项）插件的位置及尺寸
  • 内部字段：
{
    x: 0,   //（可选项）数字类型；插件左上角的 x 坐标（相对于所属的 Window 或 Frame）；android端不传默认水平居中
    y: 0,   //（可选项）数字类型；插件左上角的 y 坐标（相对于所属的 Window 或 Frame）；默认值：0
    w: 300,  //（可选项）数字类型；此参数会被忽略，实际值会根据 frame 进行自适应调整
    h: 200   //（可选项）数字类型；插件的高度；建议200
}

fixedOn：

  • 类型：字符串类型
  • 描述：（可选项）插件添加到指定 frame 的名字（只指 frame，传 window 无效）
  • 默认：插件依附于当前 window

fixed:

  • 类型：布尔
  • 描述：（可选项）插件是否随所属 window 或 frame 滚动
  • 默认值：true（不随之滚动）

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
   eventType: '',       //字符串类型；扫码事件类型
                            //取值范围：
                            //success：验证成功
                            //fail：验证失败
                            //loadFail：加载失败
   token:'', //验证成功后返回
}

示例代码

var dxCaptcha = api.require('dxCaptcha');
dxCaptcha.open({
    rect:{
    y:200
    },
    fixedOn:'',
    fixed:true
},function(ret){
    if(ret.eventType=="success"){
        dxCaptcha.close();
        api.alert({
            msg: JSON.stringify(ret)
        })
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

reload

重新加载窗口

reload()

示例代码

var dxCaptcha = api.require('dxCaptcha');
dxCaptcha.reload();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

close

关闭验证窗口

close()

示例代码

var dxCaptcha = api.require('dxCaptcha');
dxCaptcha.close();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24