安卓ocr接入文档

AI/安卓ocr接入.md

@@ -0,0 +1,178 @@
+# 配置流程
+
+## 接入配置
+
+### 注意事项
+
+- Ocr SDK 最低支持 Android 4.0 以上版本 API LEVEL 16。
+- CPU 架构支持 armeabi，arm64-v8a，armeabi-v7a，x86
+- Ocr SDK 将以 AAR 文件的形式提供，ocrui-release.aar 。
+- Ocr SDK 同时需要依赖**公共组件（common-release.aar）**，同样也是以 AAR 文件的形式提供，详情请参见 [添加依赖](#yilai)。
+
+
+<span id='yilai'></span>
+
+### 添加依赖
+
+将提供的 AAR 文件加入到 App 工程的 libs 文件夹内，并且在 build.gradle 中添加下面的配置。
+
+```
+android{
+     //...
+     repositories {
+        flatDir {
+            dirs 'libs' //this way we can find the .aar file in libs folder
+        }
+    }
+}
+
+//添加依赖
+dependencies {
+    // json依赖
+    implementation 'com.alibaba:fastjson:1.2.73'
+    // okHttp依赖
+    implementation 'com.squareup.okhttp3:okhttp:4.0.0'
+    // 公共组件
+    implementation(name: 'common-release', ext: 'aar')
+    // ocr
+    implementation(name: 'ocrui-release', ext: 'aar')
+}
+
+```
+### 权限检测
+
+在AndroidManifest.xml中添加
+```
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.CAMERA"/>
+    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+        
+```
+ - **Android 6.0 以上系统**
+SDK 需要用到以上权限，对 Android 6.0 以上的系统 SDK 会做权限的运行时检测。
+ - **Android 6.0 以下系统**
+ -由于 Android 6.0 以下系统 Android 并没有运行时权限检测，建议调用方在拉起 SDK 前，对权限进行检测。-
+
+
+
+<span id='shili'></span>
+
+# 接入示例
+
+快速调用：
+```
+# 在MainActivity中单击某个按钮的代码逻辑
+
+Credential cert=new Credential();
+cert.setPassword("xxxx");
+cert.setUserCode("xxxx");
+cert.setUrl("xxxx");
+cert.setSysName("xxxx");
+
+OcrSDK sdk = OcrSDK.getInstance();
+
+sdk.init(OcrDemoActivity.this, credential,new OcrSDK.OcrLoginListener() {
+    @Override
+    public void onLoginSuccess() { //登录成功,拉起 SDK 页面
+        OcrSDK.getInstance().startIdCardFrontActivity( new OcrSDK.ResultListener<OcrSDK.IdCardFrontData>() {
+            @Override
+            public void onFailed(String errorCode, String errorMsg) {
+                //txtresult.setText("失败：错误码"+errorCode+";错误信息"+errorMsg);
+            }
+
+            @Override
+            public void onFinish(OcrSDK.IdCardFrontData result) {
+                    int i=1;
+                //txtresult.setText("操作完成：识别结果"+result.isSuccess()+";相似分数"+result.getScore());
+            }
+        });
+    }
+
+    @Override
+    public void onLoginFailed(String errorCode, String errorMsg) {
+        //txtresult.setText("失败：错误码"+errorCode+";错误信息"+errorMsg);
+
+    }
+});
+```
+
+[完整demo下载](./demo/ocrdemo.rar) (跳转后点击查看**原始文件**)
+
+# 接口详细说明
+
+## SDK 接口调用方法
+
+SDK 代码调用的入口为 `OcrSDK` 这个类。
+
+```
+public class OcrSDK {
+    /**
+    * 该类为一个单例，需要先获得单例对象再进行后续操作
+    */
+    public static OcrSDK getInstance(){
+    //    ...
+    }
+    
+    /**
+    * 在使用SDK前先初始化，
+    * 传入证书key `credential`，
+    * 由 OcrLoginListener返回是否初始化SDK成功
+    */
+    public void init(Context context,Credential credential, final OcrLoginListener loginListerner){
+    //    ...
+    }
+
+    /**
+     * 登录成功后，调用此函数拉起sdk页面
+     * 打开身份证正面识别
+     * @param resultListener 用于返回识别结果
+     */
+    public void startIdCardFrontActivity(ResultListener<IdCardFrontResult> resultListener) {
+        //    ...
+
+    }
+
+    /**
+     * 登录成功后，调用此函数拉起sdk页面
+     * 打开身份证背面识别
+     * @param resultListener 用于返回识别结果
+     */
+    public void startIdCardBackActivity(ResultListener<IdCardBackResult> resultListener) {
+        //    ...
+
+    }
+    /**
+     * 登录成功后，调用此函数拉起sdk页面
+     * 打开银行卡识别
+     * @param resultListener 用于返回识别结果
+     */
+    public void startBankCardActivity(ResultListener<BankCardResult> resultListener) {
+        //    ...
+
+    }
+
+    /**
+     * 登录回调接口
+     */
+    public interface OcrLoginListener {
+        void onLoginSuccess();
+
+        void onLoginFailed(String errorCode, String errorMsg);
+    }
+
+    /**
+    * Ocr结果回调接口
+    */
+    public interface ResultListener<T> {
+         
+        void onFailed(String errorCode, String errorMsg);
+
+        void onFinish(T result);
+    }
+```
+
+## 接入示例
+关于接口调用的示例可参考 [接入示例](#shili)
+
+<span id='canshu'></span>

AI/安卓活体核身接入文档.md

@@ -4,7 +4,7 @@
 
 ### 注意事项
 
-- 人脸核身 SDK 最低支持到 支持 Android 4.0 以上版本 API LEVEL 16。
+- 人脸核身 SDK 最低支持 Android 4.0 以上版本 API LEVEL 16。
 - 人脸核身 SDK 仅支持 armeabi-v7a
 - 人脸核身 SDK 将以 AAR 文件的形式提供，faceid-release.aar 和 faceplatform-release.aar。
 - 人脸核身 SDK 同时需要依赖**公共组件（common-release.aar）**，同样也是以 AAR 文件的形式提供，详情请参见 [添加依赖](#yilai)。
@@ -12,8 +12,7 @@
 
 ### 配置证书和签名
 
-1. 提供应用ID和签名文件md5码获取以下3个证书文件（[如何获取应用ID和签名文件md5码](https://cugeducn-my.sharepoint.com/:b:/g/personal/zhouxc_cug_edu_cn/EQA0mcJoDFhPvJmuKXIuumEBuDf-Bo9seappz2OqhW06fQ?e=ZzQoUC)），放入您的项目目录 `app\src\main\assets`。
-    * aip.license
+1. 提供应用ID和签名文件md5码获取以下2个证书文件（[如何获取应用ID和签名文件md5码](https://cugeducn-my.sharepoint.com/:b:/g/personal/zhouxc_cug_edu_cn/EQA0mcJoDFhPvJmuKXIuumEBuDf-Bo9seappz2OqhW06fQ?e=ZzQoUC)），放入您的项目目录 `app\src\main\assets`。
     * idl-key.face-android
     * idl-license.face-android
 2. app\build.gradle 内配置：
@@ -40,15 +39,12 @@
     }
 
     ```
-  
-### 
-
 
 <span id='yilai'></span>
 
 ### 添加依赖
 
-为人脸核身 SDK 添加依赖的方式：将提供的 AAR 文件加入到 App 工程的 libs 文件夹内，并且在 build.gradle 中添加下面的配置。
+将提供的 AAR 文件加入到 App 工程的 libs 文件夹内，并且在 build.gradle 中添加下面的配置。
 
 ```
 android{
@@ -263,7 +259,3 @@ public class FaceidSDK {
 | headUp | 抬头 |
 | headDown | 点头 |
 | yaw | 摇头 |
-
-
-# 错误码
-> 非0为未通过