活体核身

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

@@ -0,0 +1,17 @@
+# 视频活体核身
+
+1. 调用 https://cepmtest.dhcccloud.com.cn/switcher/core/applyUrlToken ，使用(身份证，姓名)换取token
+    * 参数action固定传空
+    * bizContent 传 
+        ```
+        {feedback:"一个url",feedbackWay:"feedback的使用方式",idCard:"身份证",name:"姓名",mode:"验证模式"}
+        ```
+    * feedbackWay 微信银行传 redirect
+    * mode : LIP为数字模式,ACTION为动作模式,SILENT为静默模式
+2. 收到token后，浏览器跳转到活体核验页面 https://cepmtest.dhcccloud.com.cn/front-h5/pages/faceVerify/index.html?urltoken=[token]
+3. 用户录完视频得到核验结果后，浏览器跳回到feedback页面，带回token,id,key三个参数。
+4. 调用 https://cepmtest.dhcccloud.com.cn/switcher/core/feedback2UrlToken ，使用token,id,key换取核验结果
+
+# 活体人脸比对
+# 照片人脸核身
+# 图片人脸对比

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

@@ -0,0 +1,170 @@
+# 开发准备
+
+## 权限检测
+
+在AndroidManifest.xml中添加
+```
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.RECORD_AUDIO"/>
+```
+ - **Android 6.0 以上系统**
+SDK 需要用到网络/相机/录音/写入手机存储权限，对 Android 6.0 以上的系统会做权限的运行时检测。
+ - **Android 6.0 以下系统**
+ 由于 Android 6.0 以下系统 Android 并没有运行时权限检测，建议调用方在拉起 SDK 前，对网络/相机/麦克风/写入手机存储检测。
+
+<span id='shili'></span>
+
+
+# 配置流程
+
+## 接入配置
+
+### 注意事项
+
+- 人脸核身 SDK（Faceid）最低支持到 Android API 14: Android 4.0(ICS) ，请在构建项目时注意。
+- 人脸核身 SDK 将以 AAR 文件的形式提供，即 FaceidSDK.aar。
+- 人脸核身 SDK 同时需要依赖**公共组件（XXX）**，同样也是以 AAR 文件的形式提供，详情请参见 [添加依赖](#yilai)。
+
+
+<span id='yilai'></span>
+
+### 添加依赖
+
+为人脸核身 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-v7
+    compile 'com.android.support:appcompat-v7:23.0.1'
+    //1. 云刷脸SDK
+    compile(name: 'FaceidSDK', ext: 'aar') 
+}
+
+```
+
+## 混淆配置
+
+
+# 接入示例
+
+视频核身：
+```
+# 在MainActivity中单击某个按钮的代码逻辑
+
+FaceidSDK.InputData inputdata=FaceidSDK.getInstance().new InputData(name.getText().toString(),idNum.getText().toString(), videoType);
+Credential credential = new Credential();
+credential.setSysName("XXXX").setPassword("XXXX").setUserCode("XXXX").setUrl("XXXX");
+
+FaceidSDK.getInstance().init(MainActivity.this, credential,new FaceidSDK.FaceidLoginListener() {
+    @Override
+    public void onLoginSuccess() { //登录成功,拉起 SDK 页面
+        FaceidSDK.getInstance().startActivity(MainActivity.this,inputdata, new FaceidSDK.FaceidResultListener() {
+            @Override
+            public void onFailed(String errorCode, String errorMsg) {
+                txtresult.setText("失败：错误码"+errorCode+";错误信息"+errorMsg);
+            }
+
+            @Override
+            public void onFinish(FaceidSDK.OutputData result) {
+                txtresult.setText("操作完成：识别结果"+result.isSuccess()+";相似分数"+result.getScore());
+
+            }
+        });
+    }
+
+    @Override
+    public void onLoginFailed(String errorCode, String errorMsg) {
+
+    }
+});
+```
+
+# 接口调用详细说明
+
+## SDK 接口调用方法
+
+SDK 代码调用的入口为 `FaceidSDK` 这个类。
+
+```
+public class FaceidSDK {
+    /**
+    * 该类为一个单例，需要先获得单例对象再进行后续操作
+    */
+    public static FaceidSDK getInstance(){
+    //    ...
+    }
+
+    /**
+    * 在使用SDK前先初始化，
+    * 传入证书key `credential`，
+    * 由 FaceidLoginListener返回是否初始化SDK成功
+    */
+    public void init(Context context,Credential credential, FaceidLoginListener loginListerner){
+    //    ...
+    }
+
+    /**
+    * 初始化成功后，调用此函数拉起sdk页面。
+    * 传入InputData（身份证，姓名，动作类型）
+    * 由FaceidResultListener返回人脸核身结果。
+    */
+    public void startActivity(Context context,  InputData data,FaceidResultListener resultListener) {    
+        // ...
+    }
+
+    /**
+     * 初始化回调接口
+     */
+    public interface FaceidLoginListener {
+        void onLoginSuccess();
+        void onLoginFailed(String errorCode, String errorMsg);
+    }
+
+    /**
+    * 人脸核身结果回调接口
+    */
+    public interface FaceidResultListener{
+        void onFailed(String errorCode, String errorMsg);
+        void onFinish(OutputData result);
+    }
+```
+
+`startActivity()` 的第二个参数InputData用来传递数据：
+
+ ```
+    String name; //姓名
+    String idNum; //身份证
+    FaceidSDK.VideoType videoType;//LIP数字模式，ACTION动作模式， SILENT静默模式
+ ```
+
+> 以上参数被封装在 `FaceidSDK.InputData` 对象中。
+
+## 接入示例
+关于接口调用的示例可参考 [接入示例](#示例)
+
+<span id='canshu'></span>
+
+## 接口参数说明
+
+| 参数 | 说明 | 类型 | 长度（字节） | 是否必填 |
+| --- | --- | --- | --- | --- |
+| name | 核验人的姓名| String | - | 是 | 
+| idNum | 核验人的身份证号 | String | 32 | 是 |
+| videoType        | 人脸核身类型<br/>动作活体：FaceidSDK.VideoType.ACTION<br/>数字活体：FaceidSDK.VideoType.LIP<br/>静默活体：FaceidSDK.VideoType.SILENT | FaceidSDK.VideoType | -                  | 是       |
+
+
+# 错误码
+图片测试
+![图片测试](./images/测试.png)