一.准备工作

概述

本文是人像比对SDK_Android v2.0.0版本的接入文档，用于指导SDK的使用方法，默认读者已经熟悉 IDE（Eclipse 或者 Android Studio）的基本使用方法，以及具有一定的 Android 编程知识基础。

前置条件

• 人像比对SDK支持minSdkVersion 15及以上版本
• cpu架构armeabi-v7a

• 平台获取appId，appKey

快速体验demo

• Android压缩包附带的apk文件夹中是人像比对demo的安装包，可以直接安装到Android手机上。并快速体验人像比对在您的手机上的表现。
• Android压缩包附带的demo文件夹中是人像比对的示例工程，使用Android studio打开示例工程，完成以下步骤配置，然后直接运行起来测试。

a.将build里面的applicationId换成对应的测试包名

b.将签名配置改成您的签名配置

c.将AppId和AppKey换成您在人像比对平台创建应用后生成的信息

开发环境搭建

（1）将开发包拷贝到工程

将SDK中libs目录下的aar包拷贝到自己工程的libs目录下，如没有该目录需新建。

libs所在目录结构如下图：

在app文件夹下的build.gradle的dependencies中配置对应版本的aar依赖并添加repositories，详细代码如下：

apply plugin: 'com.android.application'
android {
    compileSdkVersion xx
    defaultConfig {
        applicationId "xxx.xxx.xxx"
        minSdkVersion xx
        targetSdkVersion xx
        versionCode 1
        versionName "1.0.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

repositories {
    flatDir {
        dirs '../app/libs'
    }
}

dependencies {
    compile(name: 'cllc_sdk_1_1_0', ext: 'aar')
}

（2）配置AndroidManifest.xml文件

在manifest标签内添加必要的权限支持

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

配置权限说明

(3) 混淆规则：

-keep class com.linkface.** { *; }

通过上面的几个步骤，工程就配置完成了，接下来就可以在工程中使用闪验SDK进行开发了。

二.SDK使用说明

初始化

使用人像比对前，必须先进行初始化操作。建议放在触发人像对比页面跳转前判断，回调在UI线程。

方法原型

  public void init(Context context, 
                   String appId,
                   String appKey,
                   InitStateListener listener) {
  }

参数描述

示例代码

 CLLCSDKManager.getInstance().init(getApplicationContext(),
                                  appid,appkey, 
                                  new InitStateListener() {
      @Override
      public void getInitStatus(int code, String msg) {
                
      }
});

getInitStatus(int code, String result)方法返回参数分为外层code和result，含义如下：

注意：初始化必须用户授权，否则将会失败，导致后续异常。

code错误码示例

设置检测参数

在初始化成功回调 进入检测页面 建议该方法放在活体检测Activity的onCreate() 方法中调用（必须放在主线程）。

方法原型

public void setCLLCParameter(final OcrParameter ocrParameter){}

参数描述

示例代码

CLLCParameter parameter = new CLLCParameter();
        //动作序列
        parameter.setMotionList(mDetectList);
        //输出类型
        parameter.setOutputType(“singleImg”);
        //难易程度
        parameter.setComplexity(“normal”);
        //姓名
        parameter.setName(“xxx”);
        //身份证号
        parameter.setCardNo("441xxxxxxxxxxxxxxx");
 		//添加hack检测
		parameter.setHack(true);

//设置参数
CLLCSDKManager.getInstance().setCLLCParameter(parameter);

设置状态监听和认证结果监听

在设置参数完成后设置监听 

方法原型

 public void setLivenessListener(LivenessListener livenessListener,String url) {}

示例代码

CLLCSDKManager.getInstance().setLivenessListener(new LivenessListener() {
            @Override
            public void onLivenessDetect(int value, 
                                         int status,
                                         OcrImageResult[] imageResult) {
                

            @Override
            public void startVerify() {
            }

            @Override
            public void verifyResult(int code, String result) {
               
            }
                
            @Override
            public void detectTimeout() {
             
            }
                
            @Override
            public void detectInterrupt(int type) {
               
            }
                
            @Override
            public void onError(int code, String msg) {

            }
        },userUrl);

setLivenessListener回调方法说明

LivenessListener回调方法说明

verifyResult回调 code字段说明

verifyResult回调 code为-1104    result结果的解析（result成功为json字符串）

verifyResult回调 code为1000  result结果的解析（result成功为json字符串）

data数据结构

identity数据结构

reason字段详细描述：

置信度阈值与错误率对应关系：

data成功的json示例

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "OK",
  "confidence": 0.312779,
  "selfie": { 
    "image_id": "xxxxx"
  },
  "identity": {
    "validity": true,
    "photo_id": "6963927a2b1e4fbc9abd9ff15638a2b5",
    "reason": "xxx"
  }
}

data失败的json示例

{
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e",
  "status": "INVALID_ARGUMENT",
  "reason": "Invalid idcard number"
}

status 错误码示例

添加图片数据监测

本方法主要添加图片二进制数据进行监测（在Camera.PreviewCallback的回调方法调用）

方法原型

  public void setPicData(byte[] picData, Camera camera, int w, int h, int rotateAngle){}

参数类型

示例代码

  Camera.PreviewCallback mPreviewCallback = new Camera.PreviewCallback() {
        @Override
        public void onPreviewFrame(byte[] data, Camera camera) {
            CLLCSDKManager.getInstance().setPicData(data,
                                                   camera,
                                                   PREVIEW_WIDTH,
                                                   PREVIEW_HEIGHT,
                                                   mCameraInfo.orientation);
        }
    };

重置检测

本方法在SDK内部会创建内部检测类进行重新初始化（用于重置活体检测）

方法原型

  public void resetDetector(){}

示例代码

  CLLCSDKManager.getInstance().resetDetector();

释放资源

本方法在SDK内部关闭监测线程(建议在活体检测activity的onDestroy()执行)

方法原型

  public void remove(){}

示例代码

  CLLCSDKManager.getInstance().remove();

三.SDK常量说明

常量LivenessState类（监测活体返回常量判断）