|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+# 配置流程
|
|
|
2
|
+
|
|
|
3
|
+## 接入配置
|
|
|
4
|
+
|
|
|
5
|
+### 注意事项
|
|
|
6
|
+
|
|
|
7
|
+- Ocr SDK 最低支持 Android 4.0 以上版本 API LEVEL 16。
|
|
|
8
|
+- CPU 架构支持 armeabi，arm64-v8a，armeabi-v7a，x86
|
|
|
9
|
+- Ocr SDK 将以 AAR 文件的形式提供，ocrui-release.aar 。
|
|
|
10
|
+- Ocr SDK 同时需要依赖**公共组件（common-release.aar）**，同样也是以 AAR 文件的形式提供，详情请参见 [添加依赖](#yilai)。
|
|
|
11
|
+
|
|
|
12
|
+
|
|
|
13
|
+<span id='yilai'></span>
|
|
|
14
|
+
|
|
|
15
|
+### 添加依赖
|
|
|
16
|
+
|
|
|
17
|
+将提供的 AAR 文件加入到 App 工程的 libs 文件夹内，并且在 build.gradle 中添加下面的配置。
|
|
|
18
|
+
|
|
|
19
|
+```
|
|
|
20
|
+android{
|
|
|
21
|
+ //...
|
|
|
22
|
+ repositories {
|
|
|
23
|
+ flatDir {
|
|
|
24
|
+ dirs 'libs' //this way we can find the .aar file in libs folder
|
|
|
25
|
+ }
|
|
|
26
|
+ }
|
|
|
27
|
+}
|
|
|
28
|
+
|
|
|
29
|
+//添加依赖
|
|
|
30
|
+dependencies {
|
|
|
31
|
+ // json依赖
|
|
|
32
|
+ implementation 'com.alibaba:fastjson:1.2.73'
|
|
|
33
|
+ // okHttp依赖
|
|
|
34
|
+ implementation 'com.squareup.okhttp3:okhttp:4.0.0'
|
|
|
35
|
+ // 公共组件
|
|
|
36
|
+ implementation(name: 'common-release', ext: 'aar')
|
|
|
37
|
+ // ocr
|
|
|
38
|
+ implementation(name: 'ocrui-release', ext: 'aar')
|
|
|
39
|
+}
|
|
|
40
|
+
|
|
|
41
|
+```
|
|
|
42
|
+### 权限检测
|
|
|
43
|
+
|
|
|
44
|
+在AndroidManifest.xml中添加
|
|
|
45
|
+```
|
|
|
46
|
+ <uses-permission android:name="android.permission.INTERNET" />
|
|
|
47
|
+ <uses-permission android:name="android.permission.CAMERA"/>
|
|
|
48
|
+ <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
|
|
|
49
|
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
|
|
|
50
|
+
|
|
|
51
|
+```
|
|
|
52
|
+ - **Android 6.0 以上系统**
|
|
|
53
|
+SDK 需要用到以上权限，对 Android 6.0 以上的系统 SDK 会做权限的运行时检测。
|
|
|
54
|
+ - **Android 6.0 以下系统**
|
|
|
55
|
+ -由于 Android 6.0 以下系统 Android 并没有运行时权限检测，建议调用方在拉起 SDK 前，对权限进行检测。-
|
|
|
56
|
+
|
|
|
57
|
+
|
|
|
58
|
+
|
|
|
59
|
+<span id='shili'></span>
|
|
|
60
|
+
|
|
|
61
|
+# 接入示例
|
|
|
62
|
+
|
|
|
63
|
+快速调用：
|
|
|
64
|
+```
|
|
|
65
|
+# 在MainActivity中单击某个按钮的代码逻辑
|
|
|
66
|
+
|
|
|
67
|
+Credential cert=new Credential();
|
|
|
68
|
+cert.setPassword("xxxx");
|
|
|
69
|
+cert.setUserCode("xxxx");
|
|
|
70
|
+cert.setUrl("xxxx");
|
|
|
71
|
+cert.setSysName("xxxx");
|
|
|
72
|
+
|
|
|
73
|
+OcrSDK sdk = OcrSDK.getInstance();
|
|
|
74
|
+
|
|
|
75
|
+sdk.init(OcrDemoActivity.this, credential,new OcrSDK.OcrLoginListener() {
|
|
|
76
|
+ @Override
|
|
|
77
|
+ public void onLoginSuccess() { //登录成功,拉起 SDK 页面
|
|
|
78
|
+ OcrSDK.getInstance().startIdCardFrontActivity( new OcrSDK.ResultListener<OcrSDK.IdCardFrontData>() {
|
|
|
79
|
+ @Override
|
|
|
80
|
+ public void onFailed(String errorCode, String errorMsg) {
|
|
|
81
|
+ //txtresult.setText("失败：错误码"+errorCode+";错误信息"+errorMsg);
|
|
|
82
|
+ }
|
|
|
83
|
+
|
|
|
84
|
+ @Override
|
|
|
85
|
+ public void onFinish(OcrSDK.IdCardFrontData result) {
|
|
|
86
|
+ int i=1;
|
|
|
87
|
+ //txtresult.setText("操作完成：识别结果"+result.isSuccess()+";相似分数"+result.getScore());
|
|
|
88
|
+ }
|
|
|
89
|
+ });
|
|
|
90
|
+ }
|
|
|
91
|
+
|
|
|
92
|
+ @Override
|
|
|
93
|
+ public void onLoginFailed(String errorCode, String errorMsg) {
|
|
|
94
|
+ //txtresult.setText("失败：错误码"+errorCode+";错误信息"+errorMsg);
|
|
|
95
|
+
|
|
|
96
|
+ }
|
|
|
97
|
+});
|
|
|
98
|
+```
|
|
|
99
|
+
|
|
|
100
|
+[完整demo下载](./demo/ocrdemo.rar) (跳转后点击查看**原始文件**)
|
|
|
101
|
+
|
|
|
102
|
+# 接口详细说明
|
|
|
103
|
+
|
|
|
104
|
+## SDK 接口调用方法
|
|
|
105
|
+
|
|
|
106
|
+SDK 代码调用的入口为 `OcrSDK` 这个类。
|
|
|
107
|
+
|
|
|
108
|
+```
|
|
|
109
|
+public class OcrSDK {
|
|
|
110
|
+ /**
|
|
|
111
|
+ * 该类为一个单例，需要先获得单例对象再进行后续操作
|
|
|
112
|
+ */
|
|
|
113
|
+ public static OcrSDK getInstance(){
|
|
|
114
|
+ // ...
|
|
|
115
|
+ }
|
|
|
116
|
+
|
|
|
117
|
+ /**
|
|
|
118
|
+ * 在使用SDK前先初始化，
|
|
|
119
|
+ * 传入证书key `credential`，
|
|
|
120
|
+ * 由 OcrLoginListener返回是否初始化SDK成功
|
|
|
121
|
+ */
|
|
|
122
|
+ public void init(Context context,Credential credential, final OcrLoginListener loginListerner){
|
|
|
123
|
+ // ...
|
|
|
124
|
+ }
|
|
|
125
|
+
|
|
|
126
|
+ /**
|
|
|
127
|
+ * 登录成功后，调用此函数拉起sdk页面
|
|
|
128
|
+ * 打开身份证正面识别
|
|
|
129
|
+ * @param resultListener 用于返回识别结果
|
|
|
130
|
+ */
|
|
|
131
|
+ public void startIdCardFrontActivity(ResultListener<IdCardFrontResult> resultListener) {
|
|
|
132
|
+ // ...
|
|
|
133
|
+
|
|
|
134
|
+ }
|
|
|
135
|
+
|
|
|
136
|
+ /**
|
|
|
137
|
+ * 登录成功后，调用此函数拉起sdk页面
|
|
|
138
|
+ * 打开身份证背面识别
|
|
|
139
|
+ * @param resultListener 用于返回识别结果
|
|
|
140
|
+ */
|
|
|
141
|
+ public void startIdCardBackActivity(ResultListener<IdCardBackResult> resultListener) {
|
|
|
142
|
+ // ...
|
|
|
143
|
+
|
|
|
144
|
+ }
|
|
|
145
|
+ /**
|
|
|
146
|
+ * 登录成功后，调用此函数拉起sdk页面
|
|
|
147
|
+ * 打开银行卡识别
|
|
|
148
|
+ * @param resultListener 用于返回识别结果
|
|
|
149
|
+ */
|
|
|
150
|
+ public void startBankCardActivity(ResultListener<BankCardResult> resultListener) {
|
|
|
151
|
+ // ...
|
|
|
152
|
+
|
|
|
153
|
+ }
|
|
|
154
|
+
|
|
|
155
|
+ /**
|
|
|
156
|
+ * 登录回调接口
|
|
|
157
|
+ */
|
|
|
158
|
+ public interface OcrLoginListener {
|
|
|
159
|
+ void onLoginSuccess();
|
|
|
160
|
+
|
|
|
161
|
+ void onLoginFailed(String errorCode, String errorMsg);
|
|
|
162
|
+ }
|
|
|
163
|
+
|
|
|
164
|
+ /**
|
|
|
165
|
+ * Ocr结果回调接口
|
|
|
166
|
+ */
|
|
|
167
|
+ public interface ResultListener<T> {
|
|
|
168
|
+
|
|
|
169
|
+ void onFailed(String errorCode, String errorMsg);
|
|
|
170
|
+
|
|
|
171
|
+ void onFinish(T result);
|
|
|
172
|
+ }
|
|
|
173
|
+```
|
|
|
174
|
+
|
|
|
175
|
+## 接入示例
|
|
|
176
|
+关于接口调用的示例可参考 [接入示例](#shili)
|
|
|
177
|
+
|
|
|
178
|
+<span id='canshu'></span>
|
