HarmonyOS集成说明

更新时间:2025-05-21 09:37:57

开发环境要求

应用平台

适用版本

开发环境

HarmonyOS

5.0.3及以上系统

HarmonyOS

HarmonyOS项目配置

使用模块的oh-package.json5里添加依赖

在src/libs目录下添加esignfacesdk.har文件

"dependencies": {
  "esignfacesdk": "file:src/libs/esignfacesdk.har"
},

注:资源包在【移动端SDK对接说明】文档中最下方SDK资源下载里。

权限配置

在模块module.json5添加权限,除了网络权限还需要新增相机权限

"requestPermissions": [
  {
    "name": "ohos.permission.CAMERA",
    "reason": "$string:cam_reason",
    "usedScene": {
      "abilities": [
        "EntryAbility",
      ],
      "when": "inuse"
    }
  }
]

SDK接口说明

1、SDK初始化

请求方法: EsignSDK.getInstance().initSDK(licenseKey, license, (result: InitResponse) => { })

接口说明:传入开放平台的licenseKey和license文件内容进行激活SDK。

请求参数:

请求参数

类型

必填

参数描述

licenseKey

string

e签宝开放平台获取到的licenseKey

点击查看 获取方法

license

string

e签宝开放平台获取到的license文件内字符串

点击查看 获取方法

result

InitResponse

初始化结果

注:根据返回的result.success字段判断初始化是否成功

请求示例:

2、唤起SDK刷脸

请求方法:EsignSDK.getInstance().verity(faceAuthCode, (result: FaceResultResponse) => {}

接口说明:唤起刷脸SDK

请求参数:

请求参数

类型

必填

参数描述

faceAuthCode

String

后端调用【人脸识别认证】个人核身 API接口获取的faceToken

result

FaceResultResponse

刷脸结果回调

FaceResultResponse字段

  • passed: 刷脸通过
  • completed: 刷脸操作已经完成,结果未出
  • errCode: 刷脸错误码
  • msg: 刷脸错误信息

注:根据返回result.passed字段判断刷脸是否成功,

否则就是刷脸失败,获取errCode错误码和msg错误信息进行提示

请求示例:

我要纠错