SDK接入文档(ios版)

接口说明

类MGFaceIDZZIDCardManager

函数名-initMGFaceIDZZIDCardManagerWithSign:signVersion:bizToken:extraData:error:
方法描述- (instancetype _Nullable)initMGFaceIDZZIDCardManagerWithSign:(NSString *__nonnull)signStr signVersion:(NSString *__nonnull)signVersionStr bizToken:(NSString **__nonnull)bizTokenStr extraData:(NSDictionary *__nullable)extraDict error:(MGFaceIDZZIDCardErrorItem **__nullable)error;
名称初始化方法
说明初始化FaceID自助接入身份证检测
变量名说明
signStr类型： NSString *
说明：身份签名
signVersionStr类型： NSString *
说明：签名算法版本
bizTokenStr类型： (&) NSString **
说明：业务串号
extraDict类型： NSDictionary *
说明：预留参数信息。默认为nil
error类型： (&) MGFaceIDZZIDCardErrorItem *
说明： 初始化错误类型，若没有错误，则该参数为空
函数名-startMGFaceIDZZIDcardDetect:bizToken:bizNumber:callback:
方法描述- (void)startMGFaceIDZZIDcardDetect:(UIViewController *__nonnull)detectVC bizToken:(NSString *__nonnull)bizTokenStr bizNumber:(NSString * __nullable)bizNumberStr callback:(FaceIDZZIDCardDetectResultBlock __nullable)block;
名称初始化方法
说明开始身份证检测
变量名说明
detectVC类型： UIViewController *
说明：启动检测的当前页面
bizTokenStr类型： NSString *
说明：当前启动检测的业务串号
bizNumberStr类型： NSString *
说明：客户业务流水号，建议设置为业务相关流水串号并且唯一，用于与客户业户数据关联。非必选参数，可以为nil
block类型： FaceIDZZIDCardDetectResultBlock
说明：检测结果的block回调。详情请参考(MGFaceIDZZIDcardConfig.h)
screenOrientation类型：MGFaceIDZZIDCardScreenOrientation
说明： 设备拍摄横竖屏模式, 0(竖屏，默认），1（横屏）
shootPage类型：MGFaceIDZZIDCardShootPage
说明：身份证拍摄页面，0:双面（默认），1:人像面，2:国徽面
  • 注意：每次调用-startMGFaceIDZZIDcardDetect:bizToken:bizNumber:callback: 前，请先调用-initMGFaceIDZZIDCardManagerWithSign:signVersion:bizToken:extraData:error: 接口

函数getSDKVersion

此函是为非必须函数，获取的SDK版本号便于后期定位问题，建议使用；

函数名+getSDKVersion
方法描述+ (NSString *_Nonnull)getSDKVersion;
名称获取SDK的版本号
类型说明函数
说明无
返回值NSString *， 一个字符串，表示当前SDK的版本号。

函数getSDKBuild

此函是为非必须函数，获取的SDK构筑信息便于后期定位问题，建议使用；

函数名+ getSDKBuild
方法描述+ (NSString *_Nonnull)getSDKBuild;
名称获取SDK的构筑信息
类型说明函数
说明无
返回值NSString *， 一个字符串，表示当前SDK的构建号。

枚举类型legality（证件分类）

说明该枚举用于证件检测结果的分类情况
枚举名说明
MGFaceIDZZIDCardLegalityIDPhoto正式身份证
MGFaceIDZZIDCardLegalityTemporaryIDPhoto临时身份证
MGFaceIDZZIDCardLegalityPhotocopy正式身份证的复印件
MGFaceIDZZIDCardLegalityScreen手机或者其他屏幕翻拍
MGFaceIDZZIDCardLegalityEdited用工具合成或者编辑过得身份证

枚举类型completeness（图片完整性）

说明该枚举用于证件检测结果的完整性情况
枚举名说明
MGFaceIDZZIDCardComplete完整
MGFaceIDZZIDCardCompleteAllIn不完整，但是内容区域全部在图片内
MGFaceIDZZIDCardCompletePartIn不完整，且部分内容在区域外

FaceIDZZIDCardDetectResultBlock回调函数

函数名FaceIDZZIDCardDetectResultBlock
名称该类是用户身份证检测返回的结果
方法描述typedef void(^FaceIDZZIDCardDetectResultBlock)(MGFaceIDZZIDCardErrorItem* errorItem, MGFaceIDZZIDCardDetectItem* detectItem, NSString* bizTokenStr, NSString* bizNumberStr, NSDictionary* extraOutDataDict);
类型说明函数
说明无
变量名说明
errorItem类型： MGFaceIDZZIDCardErrorItem
说明： 身份证检测相关返回信息，详情查看“MGFaceIDZZIDCardErrorItem.h”
detectItem类型： MGFaceIDZZIDCardDetectItem
说明： 身份证检测结果信息，详情查看“MGFaceIDZZIDCardDetectItem.h”
bizTokenStr类型： NSString *
说明： 检测的业务串号
bizNumberStr类型： NSString *
说明： 客户业务流水号，建议设置为业务相关流水串号并且唯一，用于与客户业户数据关联。
extraOutDataDict类型： NSDictionary *
说明： 其他反馈信息，该参数当前版本默认为空

集成说明

集成步骤：

  1. 添加SDK库：将sdk文件夹中的MGFaceIDBaseKit.framework和MGFaceIDZZIDCardKit.framework添加到工程中，添加后确保TARGETS-Build Phases-Link Binary With Libraries中可以查找到MGFaceIDBaseKit.framework和MGFaceIDZZIDCardKit.framework(Required)。如果该SDK(.framework)在非PROJECT根目录下，请确定在TARGETS-Build Settings-Framework Search Paths选项中添加了该SDK所在的目录路径。因为该framework中使用了category，需要在Ohter Linker Flags中添加'-ObjC';
  2. 添加SDK依赖：该SDK依赖于Masonry.framework。如果您的项目中没有使用到该第三方，请在项目中添加sdk文件夹中的Masonry.framework。因为该framework中使用了category，需要在Ohter Linker Flags中添加'-ObjC'。该framework也可以通过CocoaPods的方式添加；
  3. 添加系统依赖：在TARGETS-Build Phases-Link Binary With Libraries中添加AVFoundation.framework和CoreMedia.framework;
  4. 添加资源：将resource文件夹中的资源包(MGFaceIDZZIDCardResouce.bundle)添加到工程中，需要勾选(Add to targets)到指定的target；
  5. 因为该SDK中使用了C++编码，需要工程支持混编C++。设置TARGETS-Build Settings-Compile Sources As选项为‘Objective-C++’或者将调用该SDK的文件后缀名称改为mm；
  6. 添加硬件权限：因为在SDK中调用了系统相机，需要在info.plist中添加'Privacy - Camera Usage Description'；
  7. 调用SDK接口：通过 #import <MGFaceIDZZIDCardKit/MGFaceIDZZIDCardKit.h> 调用SDK中的API接口。

开发指南：

该SDK由两部分组成，分别为静态framework和模型。SDK支持的系统最低要求是iOS 8.0，只支持真机架构(arm64和armv7)，不支持模拟器架构(x86_64和i386)。

  1. 获取签名，参见文档
  2. 使用-initMGFaceIDZZIDCardManagerWithSign:signVersion:bizToken:extraData:error:接口初始化 MGFaceIDZZIDCardManager 对象，参数请查看API文档
  3. 初始化 MGFaceIDZZIDCardManager 对象成功后，使用-startMGFaceIDZZIDcardDetect:bizToken:bizNumber:callback:接口进行 身份证检测

注意：

  • 查看该SDK具体版本号+getSDKVersion
  • 查看该SDK具体构建版本号+getSDKBuild
← SDK接入文档(Android版)错误码说明 →