SDK-接入文档(android版)

接口说明

入口类

com.megvii.faceid.zzplatform.sdk.manager.FaceppManager

接口

1、获取单实例对象接口

public static synchronized FaceppManager getInstance(Context context);

• 参数说明

参数	说明
Context	android.os.Context：建议使用ApplicationContext

• 返回值说明

返回值	说明
FaceppManager	入口类FaceppManager的单实例对象

2、初始化接口

public void init( String sign, String signVer, UserConfig config, AccessCallBackListener listener);

• 调用说明

  必须在调用所有接口前，初始化成功，否则无法正常工作。

• 参数说明

参数	说明
sign	授权校验码，详细算法鉴权说明
signVer	授权算法版本号
config	用户配置自定义配置，详见类UserConfig说明
listener	初始化结果回调，详见 AccessCallBackListener说明

• UserConfig 说明

参数	设置函数	说明
idcardName	setIdcardName(String idcardName);	必选参数，用户身份证名字。
idcardNumber	setIdcardNumber(String idcardNumber);	必选参数，用户身份证号。
notifyUrl	setNotifyUrl(String notifyUrl);	非必选，验证完成后，回调结果的URL。POST的内容和get result结果保持一致（images字段除外），参见文档
bizNo	setBizNo(String bizNo);	非必选，客户自己的业务串号。
verbose	setVerbose(int verbose);	非必选，返回数据详细程度，0是默认值，仅返回结论；1是返回结论和摘要信息
securityLevel	setSecurityLevel(int securityLevel);	非必选，安全等级，1是宽松（误识率千一）；2是常规（误识率万一）；3是严格（误识率十万一），默认为2
recordSupport	setRecordSupport(boolean recordSupport);	非必选，是否支持录像
imageRef1	setImageRef2(String imageRef2);	非必选，客户参照人脸照片1
imageRef2	setImageRef2(String imageRef2);	非必选，客户参照人脸照片2

• AccessCallBackListener 说明

public interface AccessCallBackListener {
    void onSuccess(String bizToken);
    void onFailure(int statusCode);
}

参数	说明
bizToken	业务流水号，用于业务反查。
statusCode	初始化失败错误码，参见文档

• 返回值说明

返回值	说明
void	无返回值

3、开始检测接口

public void startDetect();

• 参数说明

参数	说明
无	无

• 返回值说明

返回值	说明
void	无返回值

• 注意：每次调用startDetect()前，请先调用init()接口

4、设置检测回调接口

public void setMegLiveDetectListener(MegLiveDetectListener listener);

• MegLiveDetectListener 说明

public interface MegLiveDetectListener {
    void onCallback(int code, String message);
}

参数	说明
code	detect结果状态码，参见文档
message	detect结果信息，参见文档

5、设置录像回调接口

public void setMegLiveRecordVideoListener(MegLiveRecordVideoListener listener);

• MegLiveRecordVideoListener 说明

public interface MegLiveRecordVideoListener {
    public void onRecordVideoFinish(String videoPath);
}

参数	说明
videoPath	录制视频成功返回视频存放位置, 录制视频失败或者设备不支持返回null

集成说明(Android Studio)

1. 把arr文件复制进入libs文件夹中
   

2. 在APP的gradle中加入
   

   repositories {
    flatDir{
        dirs 'libs'
        }
    }
   

3. 并在dependencies中加入compile(name:'zzplatform_sdk',ext:'aar')

   

4. 点击Rebuild Project