Android SDK提供给集成Android原生客户端开发的开发者使用。
| 条目 | 资源 |
|---|---|
| 开发目标 | 4.0以上 |
| 开发环境 | Android Studio 2.1.3 |
| 系统依赖 | v7包 |
| sdk三方依赖 | 无 |
-
在demo的
libs包下，将获取的.aar文件拖拽到工程中的libs文件夹下。 -
在拖入
.aar到libs文件夹后, 还要检查.aar是否被添加到Library,要在项目的 build.gradle下添加如下代码：repositories { flatDir { dirs 'libs' } }
并且要手动将aar包添加依赖：
compile(name: 'geetest_onepass_android_vx.y.z', ext: 'aar')
-
添加权限
<uses-permission android:name="android.permission.WRITE_SETTINGS" /> <uses-permission android:name="android.permission.READ_PHONE_STATE" /> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
开发者集成客户端sdk前, 必须先在您的服务器上搭建相应的 服务端SDK ，配置 verifyUrl ，并配置从 极验后台 获取的customId。这里以服务端 verifyUrl 配置成功，客户端开发步骤为例，如下：
-
配置初始化接口
GOPGeetestUtils.getInstance().init(MainActivity.this);
-
调用校验接口
GOPGeetestUtils.getInstance().getOnePass(phone, validate, CUSTOM_ID, gopLinster); //第一个参数为输入的手机号码 //第二个参数为接入验证码SDK返回的validate(如果只接入onepass则传null) //第三个参数为所需要配置的CUSTOM_ID //第四个参数为所需实现监听回调结果接口
集成代码参考下方的 代码示例
在项目的具体页面的onCreate方法里面进行初始化。
GOPGeetestUtils.getInstance().init(MainActivity.this);GOPGeetestUtils.getInstance().getOnePass(phone, validate, CUSTOM_ID, gopLinster);实现接口进行校验。
BaseGOPListener gopLinster=new BaseGOPListener() {
@Override
public void gopOnError(String error) {
//过程中出现的错误, 具体参考下方错误码
}
@Override
public void gopOnSendMsg(boolean success,Map<String, String> result, JSONObject jsonObject) {
//sdk内部发送短信所需要的结果，jsonObject为发送短信原因，当为true的时候表示sdk内部发送短信，false的时候自定义短信
}
@Override
public void gopOnResult(String result) {
//校验成功,返回校验成功数据
}
@Override
public String gopOnVerifyUrl() {
//返回服务端配置的 verifyUrl
return GOP_VERIFYURL;
}
@Override
public Map<String, String> gopOnVerifyUrlBody() {
// verifyUrl接口传入form数据对象
HashMap<String, String> map = new HashMap<>();
// map.put("test","test");
return null;
}
@Override
public Map<String, String> gopOnVerifyUrlJsonBody() {
// verifyUrl接口传入json数据对象
HashMap<String, String> map = new HashMap<>();
// map.put("test","test");
return null;
}
@Override
public Map<String, String> gopOnVerifyUrlHeaders() {
// verifyUrl接口传入header对象
HashMap<String, String> map = new HashMap<>();
// map.put("Content-Type","application/json;charset=UTF-8");
map.put("Content-Type", "application/x-www-form-urlencoded");
return null;
}
};额外接口实现
gopOnDobble();此接口用于未收到短信，进行再次请求时调用,默认为false。
gopOnDefaultSwitch();此接口用于判断是否调用本sdk内置短信,默认为false。
gopOnVerifyUrlHeaders;此接口用于向verifyUrl接口传递header,默认为null。
gopOnVerifyUrlBody();此接口用于向verifyUrl的接口body中传参,默认为null。
gopOnVerifyUrlJsonBody;此接口用于向verifyUrl的接口body传参，提供，默认为null。
gopOnAnalysisVerifyUrl();此接口用于拿到校验的接口返回的参数,并获取返回值回传给sdk。注意：verifyUrl接口只支持post，兼容form和json数据格式上行数据。
Form表单：重写gopOnVerifyBody方法，返回上行body参数。如果没有参数则返回为null或者未put数据的map，注意gopOnVerifyUrlJsonBody方法返回未null或者不重写
Json格式：重写gopOnVerifyUrlJsonBody方法，返回上行body参数，如果没有需要传输参数则返回未put数据的map。注意此时gopOnVerifyBody方法返回null或者不重写
默认上行body参数包括phone，process_id，accesscode，custom等，不得在gopOnVerifyUrlBody或者gopOnVerifyUrlJsonBody方法重复传入
gopOnVerifyUrlHeaders方法传入verifyUrl接口需要的header参数
在页面关闭的时候执行此方法。
@Override
protected void onDestroy() {
super.onDestroy();
GOPGeetestUtils.getInstance().cancelUtils();
}public void init(Context context)
| 参数 | 类型 | 说明 |
|---|---|---|
| context | Context | 上下文 |
costomID：产品id，请在官网申请
public void getOnePass(String phone, String validate, String customID, BaseGopListener gopListener)
| 参数 | 类型 | 说明 |
|---|---|---|
| phone | String | 用户所填的手机号 |
| validate | String | 验证码SDK返回的validate，如果未接验证码则为null |
| customID | String | 极验后台配置唯一id |
| gopListener | BaseGopListener | 回调监听器，需要开发者自己实现 |
整个流程出现错误的时候调用
public gopOnError(String error)| 参数 | 类型 | 说明 |
|---|---|---|
| error | String | 错误码 |
整个流程网关成功之后调用
public gopOnResult(String result)| 参数 | 类型 | 说明 |
|---|---|---|
| result | String | verifyUrl的验证成功的结果 |
回传verifyUrl
public String gopOnVerifyUrl()整个流程进行发送短信调用
public gopOnSendMsg(boolean success，Map<String,String> result, JSONObject jsonObject)| 参数 | 类型 | 说明 |
|---|---|---|
| success | boolean | 客户所选择的短信发送业务，如果为false，则自定义短信发送，如果为true，则表示短信业务由onepass sdk内部发送 |
| result | Map | checkMessageUrl的请求参数 |
| jsonObject | JSONObject | 发送短信的原因,有token fail和verify fail两种 |
| key | 说明 |
|---|---|
custom |
产品id |
process_id |
流水号 |
phone |
手机号 |
message_id |
发送短信的id |
message_number |
短信验证码 |
| 参数 | 类型 | 说明 |
|---|---|---|
| result | int | 当等于0的时候表示成功，2的时候表示需要提交费用，其他表示验证验证码失败 |
在activity的onDestroy()方法中实现
public void cancelUtils()
无
获取SDK版本号
public void getVersion()
无
GOPGeetestUtils.getInstance().getVersion()
-dontwarn com.geetest.onepass.**
-dontwarn com.geetest.encryption.**
-keep class com.geetest.onepass.** {
*;
}
-keep class com.geetest.encryption.** {
*;
}
SDK提供部分日志，TAG为Geetest_GOP。
OnePass产品的错误代码
| ErrorCode | Description |
|---|---|
| 231 | 网络未连接 |
| 235 | sendmessage接口返回为null |
| 237 | sendmessage接口错误 |
| 238 | 账号需充值 |
| 239 | pregateway接口返回为null |
| 240 | pregateway接口错误 |
| 242 | validate为null |
| 243 | customID为null |
| 245 | phone为null |
| 251 | Get CM token fail(获取移动token失败) |
| 252 | Get CU token fail(获取联通token失败) |
| 253 | Get CT token fail(获取电信token失败) |
| 254 | CM verify fail(移动verifyUrl接口验证失败) |
| 255 | CU verify fail(联通verifyUrl接口验证失败) |
| 256 | CT verify fail(电信verifyUrl接口验证失败) |
| 261 | gopOnVerifyUrl接口未进行传值 |
答：第一步：检查手机是否停机；第二步：若总是报251错误，检查测试apk的签名是否与在极验后台设置签名一致。总是报252错误请联系我们。总是报253错误请检查是否是2、3G网络联网（电信不支持2、3G网络进行网关验证）。
答：检查customId或者validate是否正确配置。
答：第一步：检查是否是本机号验证，检查是否是验证的手机号开启网络，确认是否是真机测试，确认verifyUrl接口为Post接口；第二步：检查verifyUrl接口是否配置正确（TAG为Geetest_GOP的Log可以看到是否成功）；第三步：打印gopOnAnalysisVerifyUrl回调的值，如果为0则成功，如果为1则失败，如果失败说明客户自己服务端接入失败，请客户服务端排查问题；第四步：如果gopOnAnalysisVerifyUrl未回调日志请参考demo打印日志。
答：本产品只兼容4.0以上系统，但是在某些特殊定制的手机上，Wifi下走数据网络的方法没有返回，会造成网关验证失败。已经确认的机型有：乐视2。
答：需要申请对应的customId，并需配置相应的服务接口。这样，Demo就可以正常使用了。
答：在1.4.4及之后的版本中,判断方式为：当前无论单卡还是双卡，都是以默认开启数据网络的卡进行网关校验的。其中，无法判断默认数据网络的卡有三种情况，这三种情况为：没有开启READ_PHONE_STATE权限；无法获取当前的IMSI；无法根据当前的IMSI来判断运营商。在1.4.4之前的版本中是利用正则表达式来匹配手机号来选择数据网络运营商.
及时查看查看极验输出日志