APICloud客户端接入

配置依赖

1. 下载APICloud模块，解压可获得iOS模块和Android模块。
   上传自定义模块选择上传文档时，分别选择iOS模块和Android模块对应目录下的文件。
2. 在APICloud Studio界面中，上传智能核身APICloud模块。
   1. 进入APICloud Studio界面，在左侧导航栏，单击图标。
   2. 在模块页面，单击自定义模块页签。
   3. 在自定义模块页签，输入有效的模块名称、模块概要及版本号，选择并上传已下载的APICloud模块。

      模块名称建议填写IdentityPlatformApiCloud。

      
   4. 单击保存。
      当自定义模块上传成功后，您可以在自定义模块页签的下方看到已上传的模块。
3. 在APICloud Studio界面中，将APICloud模块添加到项目中。
   在自定义模块页签页签，单击已上传APICloud模块右上角的图标，将APICloud模块添加到项目中。

   说明 自定义模块只对自己的账号可见。如果需要对所有开发者开放，您可以在控制台的模块管理页面提交自己的模块，官方审核通过后会发布到模块库。

   当您需要更新已上传的自定义模块时，您可以通过已上传自定义模块右上角的图标，重新上传自定义模块包，上传后再单击保存。

4. 调用智能核身服务。
   1. 获取MetaInfo数据。
      您在调用智能核身服务端发起认证请求时需要传入该值。
   2. 开始认证。调用认证接口（faceVerify函数），传入CertifyId进行认证（CertifyId通过接口InitSmartVerify获取）。
      参数说明如下表所示。

      名称	类型	描述
      certifyId	String	认证的唯一标识。
      extParams	Map<String, String>	用户自定义参数，可以为空。关于自定义的字段，请参见下表所示。

      用户自定义参数extParams支持的字段说明。

      名称	描述	示例值
      kIdentityParamKeyShowResult	是否需要展示OCR识别结果确认页。取值： YES：要展示OCR识别结果确认页。 NO：不展示OCR识别结果确认页。	YES
      kIdentityParamKeyWaterMark	自定义证件图片水印文字。默认文字为仅供业务使用。	仅供业务使用
      kIdentityParamKeyIdCardFaceOnly	是否仅识别身份证人像面。取值： YES：仅识别身份证人像面。 NO：识别身份证人像面和国徽面。	NO
      kIdentityParamKeyScanMaxTime	OCR证件扫描的超时时间，单位为秒，默认30秒。	30
      kIdentityParamKeyValidIdCardDate	是否校验身份证有效期。取值： YES：校验身份证有效期。 NO：不校验身份证有效期。 说明 当kIdentityParamKeyIdCardFaceOnly取值为NO时该参数生效。	YES
      kIdentityParamKeyNextButtonColor	OCR识别结果确认页底部按钮的底色。	#FF0000
      kIdentityParamKeyOcrMode	OCR模式。取值： PHOTO（默认）：拍照模式。 SCAN：扫描模式。	PHOTO
      kIdentityParamKeyOcrSelectPhoto	是否展示从相册选择图片的功能，取值： YES（默认）：展示从相册选择照片的功能。 NO：不展示从相册选择照片的功能。	YES

代码示例

• 获取MetaInfo数据：

  <script>
      //加载智能核身插件。
    <script type="text/javascript">
      apiready = function(){
        //自定义模块的名称。
      var identityPlugin = api.require('IdentityPlatformApiCloud');
      var metaInfo = identityPlugin.getMetaInfo();
      };
  </script>
  </script>

• 增强版活体验证服务代码示例：

  identityPlugin.faceCompare({
    "certifyId":"xxxxxxxxxx"    //填写从服务端获取的certifyId。
  }, function(ret, err){
    console.log('认证结果=>' + ret.code + ' reason=>' + ret.message);
  });

  响应结果示例：

  {
                      code:1000,    //错误码。
                      message:认证通过,    //错误码描述。
                      deviceToken:xxx,    //设备token（如果需要则获取本字段）。
                      faceImage:xxx,     //本地返回的人脸照片（如果需要则获取本字段）。
                      ocrInfo:xxx      //OCR识别结果信息（如果需要则获取本字段）。
                  }

错误码说明

Demo代码包

您可以下载Demo代码包进行体验。