faceidCard

来自于：开发者立即使用

netAuth

cardinfo

bundleIdentifier

base64tofile

注意：此模块仅适用于老客户更新维护，后期也是针对老版本的问题进行更新维护，使用新版本的用户请考虑其他模块或者和FaceID ++人员联系解决老版本适配的问题，faceidCard 版本号为1.2.1

概述

faceidCard 封装了faceid开放平台的SDK，集成了faceid身份证扫描识别获取身份证图片功能；可以获取身份证正反面图片和头像图片；开发者需要在FaceID平台上进行SDK网络授权后可以使用，平台地址FaceID平台

App使用场景

  • 扫描获取身份证正面图片和头像图片

  • 扫描获取身份证反面图片

通过身份证图片获取身份证信息

  • 身份证图片获取身份证信息使用faceID平台中身份证识别接口身份证识别接口地址
  • 身份获取信息通过接口获取后可以在应用中生成一个身份证图文信息，如下图
SDK申请授权流程
  1. 进入平台后点击控制台到登陆界面
  2. 如果没有登陆账号，请点击申请试用，填写信息后，人工联系给与测试授权账号
  3. 登陆平台后点击左侧菜单应用配置，然后点击移动端，点击绑定新的Bundle ID
  4. 选择平台（Android/IOS）,填写Bundle ID，Bundle ID为Android应用的包名和IOS的Bundle ID
  5. 点击确定后等待审核，审核成功后可以使用

netAuth

SDK网络授权

netAuth(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     code: 0      //数字类型；0为授权成功
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     code: 1     //数字类型；
  3.                 //1（授权失败），
  4.                 //0（成功）
  5. }

示例代码

  1. var faceidCard = api.require('faceidCard');
  2. faceidCard.netAuth(function(ret, err){
  3.     if(ret){
  4.         alert("SDK网络授权成功");
  5.     }else{
  6.         alert('SDK网络授权失败');
  7.     }
  8. });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

cardinfo

扫描身份证获取身份证照片信息

cardinfo({params}, callback(ret, err))

params

side：

  • 类型：数字类型
  • 描述：身份证正反面
  • 默认值：0
  • 取值范围：
    • 0（身份证正面）
    • 1（身份证反面）

imgtype：

  • 类型：字符串
  • 描述：扫描身份证成功后获取照片的形式
  • 默认值：file
  • 取值范围：
    • file（文件形式）
    • base64(base64形式)

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     file: JSON对象（imgtype 为 file 有该字段）
  3.         *内部字段
  4.         idcardImg 身份证照片文件路径
  5.         portraitImg 身份证头像照片路径 （side 为 0 有该字段）
  6.     base64:JSON对象（imgtype 为 base64 有该字段）
  7.         *内部字段
  8.         idcardImg 身份证照片base64字符串
  9.         portraitImg 身份证头像照片base64字符串 （side 为 0 有该字段）
  10. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.                 //错误码：
  4.                 //1（获取失败）
  5. }

示例代码

  1. var faceidCard = api.require('faceidCard');
  2. faceidCard.cardinfo({side:side,imgtype:'file'},
  3.     function(ret,err){        
  5.         if(ret){
  6.             if(ret.base64){
  7.                 var portraitImg = ret.base64.portraitImg;
  8.                 var idcardImg = ret.base64.idcardImg;
  9.             }
  10.             if(ret.file){
  11.                 var portraitImg = ret.file.portraitImg;
  12.                 var idcardImg = ret.file.idcardImg;
  13.             }
  14.         }else{
  15.             alert("获取失败");
  16.         }
  17.     });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

bundleIdentifier

获取IOS测试包的Bundle Identifier

bundleIdentifier(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     identifier: IOS测试包的Bundle Identifier
  3. }

err：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2. }

示例代码

  1. var faceidCard = api.require('faceidCard');
  2. faceidCard.bundleIdentifier(function(ret, err){
  3.     if(ret){
  4.         alert("IOS 的 identifier 为"+ ret.identifier);
  5.     }else{
  6.         alert('获取失败');
  7.     }
  8. });

可用性

iOS系统，

可提供的1.0.0及更高版本

base64tofile

图片的base64格式转换成为图片文件

base64tofile({params}, callback(ret, err))

params

base64：

  • 类型：字符串类型
  • 描述：图片的base64字符串
  • 默认值：null

callback(ret, err)

ret：

  • 类型：JSON对象
  • 内部字段：
  1. {
  2.     code: 返回码 0表示哦转换成功
  3.     msg:错误描述
  4.     path: code为0有效，转换为图片文件的路径
  5. }

err：

  • 类型：JSON对象
  • 内部字段：无

示例代码

  1. var faceidCard = api.require('faceidCard');
  2. faceidCard.base64tofile({'base64':ret.base64.portraitImg},function(ret,err){
  3.     if(ret){
  4.         var path = ret.path;
  5.     }else{
  6.         alert("转换失败");
  7.     }
  8.  });

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本