faceidLiveDetect

来自于:AC模块工作室立即使用

概述

faceidLiveDetect 封装了faceID开放平台的SDK,集成了faceid人脸识别功能;开发者需要在FaceID平台上进行SDK网络授权后可以使用,平台地址FaceID平台。该模块封装了活体动作和静默活体。

兼容性

FACE++ iOS 系列SDK 支持 iOS7及以上操作系统,为了提高效果,推荐使用iPhone4S 以上机器,不包含iPhone4S。

注意:客户端SDK需要授权才能使用,我们需要您绑定您客户端APP的Bundle ID,以便FaceID识别您的客户端应用。 目前,客户端 SDK 通过联网进行授权,需要将您的APP的 Bundle ID 与 SDK 绑定以进行授权识别 。

在iOS端需勾选相机、相册、麦克风的权限,否则会导致崩溃。

模块使用攻略

使用此模块之前需先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:faceidLiveDetect
  • 参数:apiKey、apiSecret
  • 配置示例:
 <feature name="faceidLiveDetect">
   <param name="apiKey" value="123" />
   <param name="apiSecret" value="1234" />
   <param name="apiKey_Android" value="123" />
   <param name="apiSecret_Android" value="1234" />
 </feature>
  • 字段描述:

    apiKey:从FACE++平台获取得apiKey apiSecret:从FACE++平台获取得apiSecret

    人脸识别过程

    有两种识别过程:1,无源比对,FaceID 将使用客户自己提供的照片作为比对人脸照;2,有源比对,表示最终的用户照片将与第三方权威数据照片进行比对。此外,如果没有“有源比对”的权限,会返回错误码;

识别模式一:无源比对

1,开发者调用 getBizToken 接口上传比对者的照片到旷视服务器

2,getBizToken 成功后,调用 startDetect 接口打开摄像头

2,模块开始通过摄像头检测活体人脸,并识别

3,模块识别成功后返回 data

4,开发者发送 data 给旷视服务器相关接口

5,服务器分析比对验证身份,并将本次识别结果返回

识别模式二:有源比对----本模块暂不支持

getBizToken

获取 bizToken

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

params

path:

  • 类型:字符串类型
  • 描述:由客户提供的参照人脸照片的路径

type:

  • 类型:数字
  • 描述:活体类型
  • 默认值:0
  • 取值范围:
    • 0 (动作活体)
    • 1(静默活体)

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
   status: true      //布尔类型;是否成功
}

示例代码

var faceidLiveDetect = api.require('faceidLiveDetect');
faceidLiveDetect.getBizToken(function(ret){
    if(ret){
       alert(JSON.stringify(ret));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

startDetect

开始检测

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

params

language:

  • 类型:字符串
  • 描述:活体类型
  • 默认值:languageCh
  • 取值范围:
    • languageCh(中文)
    • languageEn(英文)

livenessHomeBackgroundColor:

  • 类型:字符串
  • 描述:背景色(ios)

livenessHomeRingColor:

  • 类型:字符串
  • 描述:检测中圆环背景色(ios)

livenessHomeProcessBarColor:

  • 类型:字符串
  • 描述:圆环进度颜色(ios)

livenessHomePromptColor

  • 类型:字符串
  • 描述:提示文本字体颜色(ios)

livenessHomePromptSize

  • 类型:数字
  • 描述:提示文本字体大小(ios)

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
   data:  ,             //字符串类型    客户端完成验证后的加密数据。注:需用该data调用服务端接口进行数据验证
   messageStr: ''      //字符串类型; 信息描述
   extraOutDataDict:'' //字符串类型;保留字段(ios)
   bizTokenStr:''      // 字符串类型;bizToken
}

err:

  • 类型:JSON对象
  • 内部字段:
{
   messageStr: ''      //字符串类型;
   errorCode:4200,     //数字类型 :错误码(android)
}

示例代码

var faceidLiveDetect = api.require('faceidLiveDetect');
faceidLiveDetect.startDetect({
language:'languageCh'
},function(ret,err){        
  if(ret){
     alert(JSON.stringify(ret));
      }else{
     alert(JSON.stringify(err));
    }
    });

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本