帮助与文档

> >

MobVerify集成文档

一、Mob后台申请appkey

1、获取appid和appsceret

进入mob开发者后台在“管理控制台”创建新应用,

创建好后选择新添加的应用

在应用下添加“mob云验证”产品,点击左侧边栏的“mob云验证”(没添加之前是灰色的)

弹出弹框确认添加

在左侧边栏选择“mob云验证”>”概况”可复制appkey和appscret

2、上线登记

“mob云验证”下的”概况”页面,点击上线登记下的添加,上传您的应用程序包

上传好后点右边“操作”下的“设置签名”在弹出的“设置MD5签名”弹框填写MD5签名,等审核

审核通过

3、获取短信模板id

“Mob云验证”下“设置”页面拉到最下面设置“是否开启智能验证”和“是否开始短信验证码验证”开关
申请短信签名
填写短信签名信息
添加短信模板
填写您要设置的短信模板内容
获取到短信模板

4、充值

“Mob云验证”下“重置管理”页面进行支付宝充值
产品价格说明
产品价格
0.05元/次,充值越多,赠送越多
预充金额 5000 10000 20000 其他
赠送金额 1200 4500 11000 联系商务获取专属优惠

二、配置gradle

1、将下面的脚本添加到您的根模块build.gradle中:

 

}

2、在使用MobVerify模块的build.gradle中,添加MobSDK插件和扩展,如:

三、添加代码

1、初始化MobSDK

如果您没有在AndroidManifest中设置appliaction的类名,MobSDK会将这个设置为com.mob.MobApplication,但如果您设置了,请在您自己的Application类中调用:

以初始化MobSDK。

2、申请所需权限

MobVerify的验证功能需要申请必要的权限,其中包括需运行时动态申请的权限,请确保在使用验证功能前申请了必要的权限。

注:使用MobSDK插件集成时,不需要单独在manifest中申请这些权限,但需要添加运行时动态申请权限的代码。

MobVerify所需权限如下:

3、调用API

MobVerify提供两套API:有界面API无界面API,可根据需要选择使用。

3-1、有界面API

使用有界面API需设置gui true。入口在MobVerifyGui类中。

参数 必须 说明
activity 当前activity实例
GuiType 选择进入的GUI页面类型,[LOGIN:登录页面,REVERIFY:二次验证页面]
templateCode 否,若使用短信验证功能,则为“必须” String类型, Mob后台申请的短信模板编号
MobVerifyGuiCallback  接口回调

其中callback会返回验证结果GuiVerifyResult,其定义如下:

成员变量 意义
 phone String 本次验证的手机号
 verified boolean 是否通过验证
verifyType verifyType 验证类型,QUICK:快速验证,CLOUD:运营商验证,SMS:短信验证

 

示例代码如下:

使用完后,需要在适当的时机(一般是界面‘onDestroy’时),注销MobVerifyGuiCallback,以防止内存泄漏,入口在MobVerifyGui中:

参数 用途
unRegisterCallback 注销所有MobVerifyGuiCallback对象

示例代码如下:

3-2、无界面API

无界面API的入口在MobVerify类中。

参数 是否必须 说明
 templateCode String 否,若使用短信验证功能,则为“必须”  Mob后台申请的短信模板编号
 phon String 手机号
eventHandler EventHandler 事件回调

其中eventHandler包含以下回调方法:

回调方法 意义
onComplete(VerifyResult verifyResult) 验证结束,可通过verifyResult获取“验证是否通过”
onRequestVerifyCode() 发送短信成功,等待用户回传验证码
onFailure(VerifyException e) 验证失败

其中VerifyResult定义如下:

成员变量 意义
 phone String 本次验证的手机号
 verified boolean 是否通过验证
verifyType verifyType 验证类型,QUICK:快速验证,CLOUD:运营商验证,SMS:短信验证

特别说明:onRequestVerifyCode()回调非常重要,当运营商验证失败后,若开发者在Mob后台配置了使用短信验证码功能,则MobVerify会自动进入短信验证流程,发送短信成功后会通过onRequestVerifyCode()回调通知开发者,此时开发者需引导用户填写接收到的验证码,并将验证码通过以下方法回传给MobVerify:

示例代码如下:

如果开发者需要在接收到onRequestVerifyCode()回调时跳转到新的页面进行验证码输入操作,可以在新的页面通过以下方法重新向MobVerify指定EventHandler回调对象:

特别说明:MobVerify.registerEventHandler(eventHandler)方法用于向MobVerify注册新的EventHandler对象,如果多次调用,会注册多个EventHandler对象,它们都将生效;并且一旦该方法被调用,那么通过MobVerify.verify(templateCode, phone, eventHandler)方法注册的eventHandler对象将**失效**。

使用完后,需要在适当的时机(一般是页面onDestroy时),注销EventHandler,以防止内存泄漏,方法入口在MobVerify`中:

接口 参数 是否必须 用途
unRegisterEventHandler EventHandler eventHandler eventHandler: 事件回调|注销指定的EventHandler对象|
unRegisterAllEventHandler 注销所有EventHandler对象(包括通过verify()和registerEventHandler()注册的EventHandler对象)

示例代码如下:

四、混淆设置

MobVerify已经做了混淆处理,再次混淆会导致不可预期的错误,请在您的混淆脚本中添加如下的配置,跳过对MobVerify的混淆操作:

 

五、注意事项

  1. MobVerify默认会添加一套开源的GUI库,如果您不需要这个库,可以在MobVerify下设置“gui false”来关闭它
  2. MobSDK默认为MobVerify提供最新版本的集成,如果您想锁定某个版本,可以在MobVerify下设置“version “某个版本””来固定使用这个版本
  3. 如果使用MobSDK的模块会被其它模块依赖,请确保依赖它的模块也引入MobSDK插件,或在此模块的gradle中添加:apply plugin: 'com.mob.sdk'

 

相关文档