腾讯云人脸核身OCR Android SDK 接入_AI解决方案_同尘科技

开发准备

权限检测

SDK 需要用到相机权限

Android 6.0 及以上系统

SDK 运行时提示权限，需要用户授权。

Android 6.0 以下系统

Android 并没有运行时权限，检测权限只能靠开关相机进行。考虑到 SDK 的使用时间很短，快速频繁开关相机可能会导致手机抛出异常，故 SDK 内对 Android 6.0 以下手机没有做权限的检测。为了进一步提高用户体验，在 Android 6.0 以下系统上，我们建议合作方在拉起 SDK 前，帮助 SDK 做相机权限检测，提示用户确认打开了权限后再进行银行卡 OCR 识别，可以使银行卡识别体验更快更好。

CPU 平台设置

目前 SDK 支持 armeabi、armeabi-v7a、arm64-v8a，为了防止在其他 CPU 平台上 SDK Crash，建议在您的 App 的 build.gradle 里加上 abiFilter，如下所示：

defaultConfig {    ndk {          //设置支持的 so 库框架          abiFilters 'armeabi-v7a', 'armeabi', 'arm64-v8a'     }}

配置流程

接入配置

注意事项

OCR SDK（WbCloudOcr）最低支持到 Android API 14: Android 4.0(ICS)，请在构建项目时注意版本是否支持。WbCloudOcr 将以 AAR 文件的形式提供。需要为 Android SDK 添加依赖，方式如下：
将提供的 AAR 文件加入到 App 工程的 libs 文件夹下面，并且在 build.gradle 中添加下面的配置。

android{   //...   repositories {      flatDir {          dirs 'libs' //this way we can find the .aar file in libs folder      }  }}//添加依赖dependencies {   //0. appcompat-v4 compile 'com.android.support:appcompat-v4:23.1.1'//1. 云Ocr SDK compile(name: 'WbCloudOcrSdk-proRelease', ext: 'aar')//2.云公共组件compile(name: 'WbCloudNormal-release-v5.1.1', ext: 'aar')}

混淆配置

云 OCR 产品的混淆规则分为两部分，分别是云 OCR SDK 的混淆规则(v2.7.X之后的版本 WbCloudOcrSdk 已经内置了混淆规则，接入方可以忽略不加载)，云公共组件的混淆规则（接入方必须加载）。云 OCR SDK 的混淆规则

######################云 ocr 混淆规则 ocr-BEGIN##########################-keepattributes InnerClasses-keep public class com.tencent.cloud.huiyansdkocr.net.*$*{  *;}-keep public class com.tencent.cloud.huiyansdkocr.net.*{  *;}-keep public class com.tencent.fujikoli.recdetectdemo.Jni.ScanRecNative{*;}
#######################云 ocr 混淆规则 ocr-END###########################

云公共组件的混淆规则

#######################normal混淆规则-BEGIN##############################不混淆内部类-keepattributes InnerClasses-keepattributes *Annotation*-keepattributes Signature-keepattributes Exceptions
-keep public class com.tencent.cloud.huiyansdkface.normal.net.*$*{  *;}-keep public class com.tencent.cloud.huiyansdkface.normal.net.*{  *;}-keep public class com.tencent.cloud.huiyansdkface.normal.thread.*{ *;}-keep public class com.tencent.cloud.huiyansdkface.normal.tools.*{ *;}-keep public class com.tencent.cloud.huiyansdkface.normal.thread.*$*{ *;}
-keep public class com.tencent.cloud.huiyansdkface.normal.tools.secure.*{ *;}
-keep public class com.tencent.cloud.huiyansdkface.normal.tools.WLogger{  *;}-keep class com.tencent.bugly.idasc.**{  *;}#wehttp混淆规则-dontwarn com.tencent.cloud.huiyansdkface.okio.**-keep class com.tencent.cloud.huiyansdkface.okio.**{  *;}
# 里面 有 Java8的一些类 如 Duration-dontwarn com.tencent.cloud.huiyansdkface.okhttp3.OkHttpClient$Builder-keep class com.tencent.cloud.huiyansdkface.wehttp2.**{  public ;}
-keep class com.tencent.cloud.huiyansdkface.okhttp3.**{  public ;}
-keep interface com.tencent.cloud.huiyansdkface.wehttp2.**{  public ;}-keep public class com.tencent.cloud.huiyansdkface.wehttp2.WeLog$Level{  *;}-keep class com.tencent.cloud.huiyansdkface.wejson.*{  *;}
-keep public class com.tencent.cloud.huiyansdkface.wehttp2.WeReq$ErrType{  *;}
-keep class * extends com.tencent.cloud.huiyansdkface.wehttp2.WeReq$WeCallback{ public ;}
-keep class com.tencent.cloud.huiyansdkface.okio.**{  *;}#######################normal混淆规则-END#############################

您可以将如上代码拷贝到您的混淆文件中，也可以将 SDK 中的 kyc-cloud-normal-proguard-rules.pro 拷贝到主工程根目录下，然后通过 -include kyc-cloud-normal-proguard-rules.pro 加入到您的混淆文件中。

接口调用

SDK 接口提供的是有 UI 模式：：SDK 对接口进行封装并且实现了识别页面，合作方只需要调用接口，即可以快速拉起 SDK，接收结果回调。接入简单，适合快速接入。

SDK 接口调用方法

SDK 代码调用的入口为 com.tencent.cloud.huiyansdkocr.WbCloudOcrSDK 这个类。

public class WbCloudOcrSDK{
/*** 该类为一个单例，需要先获得单例对象再进行后续操作   */       public static synchronized WbCloudOcrSDK getInstance() {       //    ...       }
 /**  * 初始化云Ocr SDK，完成登录  * @param context        拉起SDK的context  * @param wbocrtypemode  识别证件的模式，参数是枚举类型  * @param data           第三方需要传入的参数  * @param loginListener  登录SDK回调  */public void init(Context context,WBOCRTYPEMODE wbocrtypemode,Bundle data,OcrLoginListener loginListerner){//    ...}   /**     * 登录成功后，调用此函数拉起 sdk 页面     * @param context                  拉起 SDK 的上下文     * @param idCardScanResultListener 返回到第三方的接口     */    public void startActivityForOcr(Context context,IDCardScanResultListener){  // ... }/**  * 登录回调接口  */public interface OcrLoginListener {        void onLoginSuccess();        void onLoginFailed(String errorCode, String errorMsg);    }
/**  * 退出 SDK,返回第三方的回调,同时返回 ocr 识别结果  */public interface IDCardScanResultListener{/** * 退出SDK,返回第三方的回调,同时返回ocr识别结果 * @param errorCode 返回码，识别成功返回 0 * @param errorMsg  返回信息 * @param result 识别结果类 */        void onFinish(String errorCode, String errorMsg, Parcelable result);}

NONCE 类型的 ticket，其有效期为120秒，且一次性有效，即每次启动 SDK 刷脸都要重新请求 NONCE ticket，重新算 sign。同时建议合作方做前端保护，防止用户连续点击，短时间内频繁启动 SDK。WbCloudOcrSdk.init()的第二个参数用来传递数据，可以将参数打包到data(Bundle)中，必须传递的参数包括：

//这些都是 WbCloudOcrSdk.InputData 对象里的字段，是需要传入的数据信息String orderNo;  //每次OCR识别请求的唯一订单号: 建议为32位字符串(不超过32位)String openApiAppId;  //APP_ID String openApiAppVersion;  //openapi  VersionString openApiNonce; //32 位随机字符串String openApiUserId; //user idString openApiSign; //签名信息

注意 以上参数被封装在 WbCloudFaceVerifySdk.InputData 对象中（它是一个 Serializable 对象）。ResultOfBank 代表 SDK 返回的识别银行卡的结果，该类属性如下所示：

public String ocrId;//识别的唯一标识public String bankcardNo;//识别的银行卡号public String bankcardValidDate;//识别的银行卡的有效期public String orderNo;//每次OCR识别请求的唯一订单号: 建议为32位字符串(不超过32位)public String warningMsg;   //识别的警告信息public String warningCode;  //识别的警告码public Bitmap bankcardNoPhoto;//识别的银行卡的卡号图片public String ocrId;  //识别的唯一标识public String bankcardNo; //银行卡号public String bankcardValidDate; //银行卡的有效期public String orderNo; // 每次OCR识别请求的唯一订单号: 建议为32位字符串(不超过32位)public String warningMsg;public String warningCode;public String bankcardNoPhoto;public String bankcardNoPhotoSrc; //银行卡的卡号切边图的路径public String bankcardFullPhotoSrc;//银行卡图片存放路径public String retry;public String sign;//新增public String multiWarningCode;//多重告警码public String multiWarningMsg;//多重告警信息public String clarity;//清晰度得分//新版本新增字段public String bankcardName;//银行卡名称public String bankcardType;//银行卡类型public String bankcardInfo;//银行卡信息

登录回调接口

/**  * 登录回调接口  */public interface OcrLoginListener {        void onLoginSuccess();//登录成功          /**           * @PARAM errorCode 登录失败错误码           * @PARAM errorMsg  登录失败错误信息           */                 void onLoginFailed(String errorCode, String errorMsg);    }

返回第三方接口

/**  * 退出 SDK,返回第三方的回调,同时返回ocr识别结果  */public interface IDCardScanResultListener{/** * 退出SDK,返回第三方的回调,同时返回ocr识别结果 * @param errorCode 返回码，识别成功返回 0 * @param errorMsg  返回信息 * @param result 识别结果类 */        void onFinish(String errorCode, String errorMsg, Parcelable result);}

银行卡识别结果类

ResultOfBank 类中，通过 onFinish()回调参数 parcelableResult 获得，该类属性如下所示：

public String ocrId;//识别的唯一标识public String bankcardNo;//识别的银行卡号public String bankcardValidDate;//识别的银行卡的有效期public String orderNo;// 每次OCR识别请求的唯一订单号: 建议为32位字符串(不超过32位)public String warningMsg;   //识别的警告信息public String warningCode;  //识别的警告码public Bitmap bankcardNoPhoto;//识别的银行卡的卡号图片public String ocrId;  //识别的唯一标识 public String bankcardNo; //银行卡号 public String bankcardValidDate; //银行卡的有效期 public String orderNo; // 每次OCR识别请求的唯一订单号: 建议为32位字符串(不超过32位) public String warningMsg; public String warningCode; public String bankcardNoPhoto; public String bankcardNoPhotoSrc; //银行卡的卡号切边图的路径 public String bankcardFullPhotoSrc;//银行卡图片存放路径public String retry; public String sign;//新增public String multiWarningCode;//多重告警码public String multiWarningMsg;//多重告警信息public String clarity;//清晰度得分 //新版本新增字段public String bankcardName;//银行卡名称 public String bankcardType;//银行卡类型 public String bankcardInfo;//银行卡信息

接口参数说明

NONCE 类型的 ticket，其有效期为120秒，且一次性有效，即每次启动 SDK 刷脸都要重新请求 NONCE ticket，重新算 sign。同时建议合作方做前端保护，防止用户连续点击，短时间内频繁启动 SDK。
InputData 是用来给 SDK 传递一些必须参数所需要使用的对象（WbCloudOcrSdk.init() 的第二个参数），合作方需要加入 SDK 需要的一些数据以便启动 OCR SDK。
其中 InputData 对象中的各个参数定义如下表，请合作方按下表标准加入对应的数据。

个性化参数设置

WbCloudOcrSdk.init()里的Bundle data，除了必须要传的 InputData 对象之外，还可以由合作方为其传入一些个性化参数，量身打造更契合自己 App 的 SDK。如果合作方未设置这些参数，则以下所有参数按默认值设置。

设置 SDK 的扫描识别的时间上限

合作方可以设置 SDK 的扫描识别时间的上限。 SDK 打开照相机进行扫描识别的时间上限默认是20秒，20秒内若识别成功则退出扫描界面，否则一直识别，直到20秒后直接退出扫描界面。第三方可对其个性化设置，设置的时间上限不能超过60秒，建议第三方采用默认值，不要修改这个参数。设置代码如下：

# 在 MainActivity 中单击某个按钮的代码逻辑：  //先将必填的 InputData 放入 Bundle 中  data.putSerializable(WbCloudFaceVerifySdk.INPUT_DATA, inputData);  //设置 SDK 扫描识别证件（身份证、银行卡）的时间上限，如果不设置则默认 20 秒；设置了则以设置为准  //此处设置 SDK 的扫描识别时间的上限为 20 秒   data.putLong(WbCloudOcrSDK.SCAN_TIME, 20000);

个性化设置接入示例

# 在 MainActivity 中单击某个按钮的代码逻辑：  //先将必填的 InputData 放入 Bundle 中  data.putSerializable(WbCloudOcrSDK.INPUT_DATA, inputData);  //设置扫描识别的时间上限,默认 20 秒，此处设置为 20 秒  data.putLong(WbCloudOcrSDK.SCAN_TIME, 20000);

OCR Android 错误码

终端返回错误码

后台返回错误码

接入示例

# 在 MainActivity 中单击某个按钮的代码逻辑：//先填好数据   Bundle data = new Bundle();        WbCloudOcrSDK.InputData inputData = new WbCloudOcrSDK.InputData(                orderNo,                appId,                openApiAppVersion,                nonce,                userId,                sign);        data.putSerializable(WbCloudOcrSDK.INPUT_DATA, inputData);  //个性化参数设置,可以不设置，不设置则为默认选项。  //设置扫描识别的时间上限,默认20秒，建议默认。用户有效设置范围（0-60000）  data.putLong(WbCloudOcrSDK.SCAN_TIME, 20000);  //初始化 sdk，得到是否登录 sdk 成功的结果         WbCloudOcrSDK.getInstance().init(MainActivity.this, WbCloudOcrSDK.WBOCRTYPEMODE.WBOCRSDKTypeBankSide,data, new WbCloudOcrSDK.OcrLoginListener() {            @Override            public void onLoginSuccess() {  //登录成功,拉起 SDK 页面                              WbCloudOcrSDK.getInstance().startActivityForOcr(MainActivity.this,      new  WbCloudOcrSDK.IDCardScanResultListener() {  //返退出 SDK 回调接口                   @Override                    public void onFinish(                        final String resultCode, final String resultMsg, Parcelable parcelableResult) {                        // 登录成功  第三方应用对ocr结果进行展示等操作                         // TODO: 客户自己处理结果，下面代码仅供参考                        Intent i;                         if (type.equals(WbCloudOcrSDK.WBOCRTYPEMODE.WBOCRSDKTypeBankSide)) {                                //银行卡识别，跳转到银行卡结果展示页面                                i = new Intent(MainActivity.this, BankOcrResultActivity.class);                                i.putExtra("bankcardresult", parcelableResult);                                i.putExtra("appId", appId);                                i.putExtra("envUrl", envUrl);                            }                        }        });    }            @Override            public void onLoginFailed(String errorCode, String errorMsg) {                if(errorCode.equals(ErrorCode.IDOCR_LOGIN_PARAMETER_ERROR)) {                Toast.makeText(MainActivity.this, "传入参数有误！" + errorMsg, Toast.LENGTH_SHORT).show();                    } else {                    Toast.makeText(MainActivity.this, "登录 OCR sdk 失败！" + "errorCode= " + errorCode + " ;errorMsg=" + errorMsg, Toast.LENGTH_SHORT).show();                    }                }            });



对解决方案有疑惑？想了解解决方案收费？ 联系解决方案专家

腾讯云限时活动1折起，即将结束： 马上收藏

同尘科技为腾讯云授权服务中心，购买腾讯云享受折上折，更有现金返利:同意关联，立享优惠

阿里云解决方案也看看？： 点击对比阿里云的解决方案