Skip to content

Latest commit

 

History

History
112 lines (108 loc) · 4.47 KB

Android SDK接入.md

File metadata and controls

112 lines (108 loc) · 4.47 KB
Raw

!目前验证码的 Android SDK 接入方式已暂停维护，仅支持部分存量用户使用，若您需接入验证码服务，请参见 Web 前端接入。

前提条件

准备 AppID

验证码接入前，需要先在 验证码控制台 中注册 AppID 和 AppSecret，注册完成后，您可以在控制台的 基础配置 中查看 AppID 以及 AppSecret。

SDK 包下载与运行环境准备

  • 单击 下载 Android SDK。
  • 本 SDK 运行环境与项目要求：适用于 Android4.0 及以上的系统版本。SDK 工具包目录结构说明如下：
.
├── sdk                # captchasdk-release-1.0.2.aar
└── CaptchaDemo        # 示例工程,演示了如何使用captchasdk-release-1.0.2.aar

接入步骤

本 SDK 提供验证码 Dialog 和验证码 Activity 两种使用方式。

方式1：使用验证码 Dialog

  1. 创建一个验证码 dialog。
/**
 @param context，上下文
 @param appid，业务申请接入验证码时分配的appid
 @param listener，验证码验证结果回调
 @param jsonString，业务自定义参数
*/
TCaptchaDialog dialog = new TCaptchaDialog(context, appid, listener, jsonString);
  1. 显示验证码。
dialog.show();

其中 jsonString 是 json 字符串，可以为 null。

JSONObject jsonObject = new JSONObject();
jsonObject.put("uin", Integer.parseInt(uin));
jsonString = URLEncoder.encode(jsonObject.toString(), "utf-8");

其中 listener 根据回调函数返回的 json 对象值判断验证是否成功。

/**
json 对象值：jsonObject.getInt("ret")
*/
TCaptchaVerifyListener listener = new TCaptchaVerifyListener() {
    @Override
    public void onVerifyCallback(JSONObject jsonObject) {
        int ret = jsonObject.getInt("ret");
        if(ret == 0) {
            //验证成功回调
            //jsonObject.getInt("ticket")为验证码票据
            //jsonObject.getString("appid")为 AppID
            //jsonObject.getString("randstr")为随机串
        } else if(ret == -1001) {
            //验证码首个 TCaptcha.js 加载错误，业务可以根据需要重试
            //jsonObject.getString("info")为错误信息
        } else {    
            //验证失败回调，一般为用户关闭验证码弹框
        }
    }
}

方式2：使用验证码 Activity

  1. 创建 intent。
/**
 @param AppID，业务申请接入验证码时分配的 AppID
*/
Intent intent = new Intent(this, TCaptchaPopupActivity.class);
intent.putExtra("appid", ***);
/**
用户自定义参数，可选；
-自定义参数放到 intent 的 map 字段中
JSONObject jsonObject = new JSONObject();
jsonObject.put("uin", Integer.parseInt(uin));
intent.putExtra("map", URLEncoder.encode(jsonObject.toString(), "utf-8"));
*/
startActivityForResult(intent, 1);
  1. 传入 AppID，启动 TCaptchaPopupActivity。
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    if(requestCode == 1 && data != null) {
        switch(resultCode) {
            case Activity.RESULT_OK: {
                JSONObject jsonObject = new JSONObject(data.getStringExtra("retJson"));
                int ret = jsonObject.getInt("ret");
                if(ret == 0) {
                    //验证成功回调，此时ret=0，
                    //jsonObject.getInt("ticket")为验证码票据
                    //jsonObject.getString("appid")为appid
                    //jsonObject.getString("randstr")为随机串
                } else if(ret == -1001) {
                    //验证码收个TCaptcha.js加载错误，业务可以根据需要重试
                    //jsonObject.getString("info")为错误信息
                } else {    
                    //验证失败回调，一般为用户关闭验证码弹框
                }
                break;
            }
            case Activity.RESULT_CANCELED: {
                //用户按了返回键，关闭验证码未验证成功
                break;
            }
            default:
                break;
        }
    }
}

至此，验证码客户端接入已完成，您可以进行 后台 API 接入 操作。