VAPTCHA-ANDROID SDK部署文档

行为验证 Android SDK提供给集成Android原生客户端开发的开发者使用, SDK不依赖任何第三方库。

环境需求

条目
开发目标 API 14+
开发环境 android studio
demo依赖 okgo

资源下载

条目 资源地址
jar下载 vaptcha_android_libary
Demo工程下载 vaptcha_android

配置

1.获取JAR包

通过git命令获取:

//Step 1. Add the JitPack repository to your build file
  maven { url 'https://www.jitpack.io' }
//Step 2. Add the dependency
implementation 'com.github.VAPTCHA:VAPTCHA-android:1.0.0',{ exclude module: "okio" }

手动下载JAR包:
Github:vaptcha_android_libary

2.studio导入

模式分类

模式 type 描述
嵌入式 embed 自定义验证视图 在xml中直接引入
点击式 popup 自定义按钮 在xml中直接引
隐藏式 invisible 定义了java方法 在用户需要的地方直接调用

manifest中加入加入权限:

//网络权限
<uses-permission android:name="android.permission.INTERNET"/>
//获取当前网络状态
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>

代码示例

1. 嵌入式
//在xml中直接引用并配置
 <com.vaptcha.VaptchaView
       android:id="@+id/vaptchaView"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:vaptcha_scene="01"
        app:vaptcha_type="embed"
        app:vaptcha_vid="5af01666a485d42f244c7d0d"
        />
//初始化 并设置监听
        VaptchaView  vaptchaView = findViewById(R.id.vaptchaView);
        vaptchaView.setVaptchaListener(new vaptchaListener() {
                @Override
                public void onError() {
//                    验证失败
                }
                @Override
                public void onExection() {
//                    验证异常
                }
                @Override
                public void onSuccess(String token) {
//                    验证成功 拿到token
                    tv_login.setEnabled(true);
                }
            });
//验证重置
       vaptchaView.vaptchaReset();

参数说明

参数名 描述
vaptcha_type embed(嵌入式) 必填
vaptcha_vid vaptcha获取到的vid 必填
vaptcha_scene 描述 必填
vaptcha_isOutAge true进入宕机模式 选填
vaptcha_outage_url 宕机模式的服务器地址 选填
vaptcha_lang 语言(简体中文 zh-Hans)(繁体中文 zh-Hant)(英文 en) 选填

效果图


嵌入式 效果图
2点击式
  <com.vaptcha.VaptchaView
  android:id="@+id/vaptchaButton"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:vaptcha_color="#cccccc"
        app:vaptcha_scene="01"
        app:vaptcha_type="popup"
        app:vaptcha_vid="5af01666a485d42f244c7d0d" />
//初始化 并设置监听
     vaptchaButton=mView.findViewById(R.id.vaptchaButton);
     vaptchaButton.setVaptchaListener(new vaptchaListener() {
                @Override
                public void onError() {
            //                    验证失败
                }
                @Override
                public void onExection() {
        //                    验证异常
                }
                @Override
                public void onSuccess(String token) {
//                    验证成功 拿到token
                }
            });
//验证重置
        vaptchaButton.vaptchaReset();

参数说明

参数名 描述
vaptcha_type popup(点击式) 必填
vaptcha_vid vaptcha获取到的vid 必填
vaptcha_scene 描述 必填
vaptcha_isOutAge true进入宕机模式 选填
vaptcha_outage_url 宕机模式的服务器地址 选填
vaptcha_color 按钮颜色 选填
vaptcha_lang 语言(简体中文 zh-Hans)(繁体中文 zh-Hant)(英文 en) 选填

效果图


点击式 效果图

3隐藏式

  //初始化VaptchaView   并传入配置参数
   VaptchaView  hide_view =new VaptchaView(getContext(), "invisible", "5af01666a485d42f244c7d0d", "01");
  //调起验证界面
  hide_view.show();
//添加验证监听
  hide_view.setVaptchaListener( new vaptchaListener() {
        @Override
        public void onError() {
      //验证错误
        }
        @Override
        public void onExection() {
           //验证异常
        }
        @Override
        public void onSuccess(String token) {
        //验证成功
        }
    };);

参数说明

参数名 描述
Context 上下文 必填
vaptcha_type invisible 必填
vaptcha_vid vaptcha获取到的vid 必填
vaptcha_scene 描述 必填
vaptcha_isOutAge true进入宕机模式 选填
vaptcha_outage_url 宕机模式的服务器地址 选填
vaptcha_lang 语言(简体中文 zh-Hans)(繁体中文 zh-Hant)(英文 en) 选填

效果图


隐藏式 效果图

以上为VAPTCHA SDK提供的三种验证方式,具体更多参数设置详见 Demo

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,036评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,046评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,411评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,622评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,661评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,521评论 1 304
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,288评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,200评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,644评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,837评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,953评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,673评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,281评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,889评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,011评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,119评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,901评论 2 355