Harmony SDK UI 自定义配置说明_实人认证(ID Verification)-阿里云帮助中心

金融级实人认证服务Harmony SDK提供自定义UI颜色、icon图标和UI文案的接口，开发者可以通过调用setCustomUI或setCustomTxtConfig接口进行自定义。本文为您介绍UI自定义接口说明以及相关的代码示例。

重要

部分自定义配置可能需要依赖SDK升级，建议您在使用之前将SDK升级至最新版本。

页面 UI 颜色和 ICON 自定义

目前支持自定义引导页及活体认证页的字体颜色以及图标。

接口说明

Harmony SDK中提供了自定义UI的接口：setCustomUIConfig。

/**
 * UI自定义
 * @param config json文本
 * @return 配置文件检测出的异常信息
 */
  public static setCustomUIConfig(config:string) : string {
      ......
  }

参数说明：config 传入UI颜色配置 JSON 字符串。
返回值：当 SDK 对 config 参数内容解析的时候遇到错误或者异常信息时会通过提示信息的方式返回，当您在配置参数无效时，请重点关注此值信息。

调用示例

ZimFacadeExt.setCustomUIConfig('{"guideConfig":{}, "faceConfig":{}}');

UI颜色配置

{
  "guideConfig": {
    "titleCloseBase64":"",
    "titleBackBase64":"",
    "dialogExitTitleColor": "#000000",
    "dialogExitMsgColor": "#000000",
    "dialogExitCancelColor": "#0E83E6",
    "dialogExitConfirmColor": "#0E83E6",
    "dialogNetworkFailedTitleColor": "#000000",
    "dialogNetworkFailedMsgColor": "#000000",
    "dialogNetworkFailedConfirmColor": "#0E83E6"
  },
  "faceConfig": {
    "faceBgColor": "#FFFFFF",
    "faceTitleColor": "#000000",
    "faceProgressStartColor": "#dfe6eb",
    "faceProgressEndColor": "#FF6A00",
    "circleTxtBgAlpha": "0.25",
    "circleTxtColor": "#ffffff",
    "exitIconBase64": "",
    "submitTextColor": "#E4E4E4",
    "submitLoadingIconBase64": "",
    "dialogPermissionFailedTitleColor": "#000000",
    "dialogPermissionFailedMsgColor": "#000000",
    "dialogPermissionFailedConfirmColor": "#0E83E6",
    "dialogExitTitleColor": "#000000",
    "dialogExitMsgColor": "#000000",
    "dialogExitCancelColor": "#0E83E6",
    "dialogExitConfirmColor": "#0E83E6",
    "dialogTimeOutTitleColor": "#000000",
    "dialogTimeOutMsgColor": "#000000",
    "dialogTimeOutConfirmColor": "#0E83E6",
    "dialogNetworkFailedTitleColor": "#000000",
    "dialogNetworkFailedMsgColor": "#000000",
    "dialogNetworkFailedConfirmColor": "#0E83E6",
    "dialogSDKErrTitleColor": "#000000",
    "dialogSDKErrMsgColor": "#000000",
    "dialogSDKErrConfirmColor": "#0E83E6",
    "dialogTooManyRetriesTitleColor": "#000000",
    "dialogTooManyRetriesMsgColor": "#000000",
    "dialogTooManyRetriesConfirmColor": "#0E83E6",
    "dialogCamOpenFailedTitleColor": "#000000",
    "dialogCamOpenFailedMsgColor": "#000000",
    "dialogCamOpenFailedConfirmColor": "#0E83E6"
  }
}

UI颜色配置字段详细说明

模块	key	截图	补充说明
引导页 guideConfig	titleBackBase64		返回icon的base64 例如：“data:image/jpeg;base64,/9j..”
	titleCloseBase64		退出icon的base64 例如：“data:image/jpeg;base64,/9j..”
	dialogNetworkFailedTitleColor		网络异常弹框配色
	dialogNetworkFailedMsgColor
	dialogNetworkFailedConfirmColor
	dialogExitTitleColor		退出弹窗配色
	dialogExitMsgColor
	dialogExitCancelColor
	dialogExitConfirmColor
活体页 faceConfig	faceBgColor		刷脸页背景色
	faceTitleColor		刷脸页标题字体颜色
	faceProgressStartColor		取景框（环形进度条）颜色起始色值
	faceProgressEndColor		取景框（环形进度条）颜色终止色值
	circleTxtBgAlpha		蒙层不透明度取值范围：（0，1）
	circleTxtColor		蒙层上方文案颜色
	exitIconBase64		退出icon的base64 例如：“data:image/jpeg;base64,/9j..”
	submitTextColor		认证提交loading提示文案字体颜色
	submitLoadingIconBase64		loading的base64 例如：“data:image/jpeg;base64,/9j..”
	dialogPermissionFailedTitleColor		权限拒绝弹框配色
	dialogPermissionFailedMsgColor
	dialogPermissionFailedConfirmColor
	dialogExitTitleColor		退出弹框配色
	dialogExitMsgColor
	dialogExitCancelColor
	dialogExitConfirmColor
	dialogTimeOutTitleColor		操作超时弹框配色
	dialogTimeOutMsgColor
	dialogTimeOutConfirmColor
	dialogNetworkFailedTitleColor		网络异常弹窗配色
	dialogNetworkFailedMsgColor
	dialogNetworkFailedConfirmColor
	dialogSDKErrTitleColor		操作失败弹窗配色
	dialogSDKErrMsgColor
	dialogSDKErrConfirmColor
	dialogTooManyRetriesTitleColor		重试过多弹框配色
	dialogTooManyRetriesMsgColor
	dialogTooManyRetriesConfirmColor
	dialogCamOpenFailedTitleColor		摄像头打开异常弹窗配色
	dialogCamOpenFailedMsgColor
	dialogCamOpenFailedConfirmColor

文案自定义

目前支持引导页及活体认证页展示文案自定义。

接口说明

Harmony SDK 中提供了自定义文案的接口：setCustomTxtConfig。

  /**
   * 文案自定义
   * @param config json文本
   * @return 设置结果，空字符串表示正常，失败的参考返回错误信息
   */
  public static setCustomTxtConfig(config:string) : string {
    ......
  }

参数说明：config 传入文案配置JSON 字符串。
返回值：当 SDK 对 config 内容解析的时候遇到错误或者异常信息时会通过提示信息的方式返回，当您在配置参数无效时，请重点关注此值信息。

调用示例

ZimFacadeExt.setCustomTxtConfig('{"guideConfig":{},"faceConfig":{}}');

文案配置

{
  "guideConfig": {
    "dialogExitTitle": "确定退出吗?",
    "dialogExitMsg": "露个脸就能通过",
    "dialogExitConfirm": "确定",
    "dialogExitCancel": "取消",
    "dialogNetworkFailedTitle": "网络不给力",
    "dialogNetworkFailedMsg": "请检查网络",
    "dialogNetworkFailedConfirm": "确定"
  },
  "faceConfig": {
    "faceNotFound": "没有检测到脸",
    "faceTooFar": "靠近一点",
    "faceTooClose": "离远一点",
    "faceNotIn": "把脸移入圈内",
    "badPitch": "请正对手机",
    "badYaw": "请正对手机",
    "faceTooMore": "请保持单人操作",
    "faceIsMoving": "再清晰一点",
    "faceBrightless": "脸部亮一点",
    "faceBadQuality": "请露出正脸",
    "eyesOnScreen": "请注视屏幕",
    "blink": "眨眨眼",
    "leftYaw": "向左摇头",
    "rightYaw": "向右摇头",
    "stackTime": "请保持不动",
    "isBlur": "再清晰一点",
    "faceInitTxt": "请正对屏幕",
    "faceTitleBlink": "拿起手机，眨眨眼",
    "leftYawLiveness": "拿起手机，向左摇头",
    "rightYawLiveness": "拿起手机，向右摇头",
    "photinusCommTips": "请把脸移入圈内保持不动",
    "processing": "正在处理",
    "dialogExitTitle": "确定退出吗?",
    "dialogExitMsg": "露个脸就能通过",
    "dialogExitConfirm": "确定",
    "dialogExitCancel": "取消",
    "dialogCamOpenFailedTitle": "摄像头打开异常",
    "dialogCamOpenFailedMsg": "请重启app或手机后再次尝试",
    "dialogCamOpenFailedConfirm": "确定",
    "dialogCamOpenFailedCancel": "取消",
    "dialogTooManyRetriesTitle": "本次操作失败",
    "dialogTooManyRetriesMsg": "刷脸失败次数过多，请稍后再试",
    "dialogTooManyRetriesConfirm": "我知道了",
    "dialogTimeOutTitle": "操作超时",
    "dialogTimeOutMsg": "正对手机，更容易成功",
    "dialogTimeOutConfirm": "再试一次",
    "dialogNetworkFailedTitle": "网络不给力",
    "dialogNetworkFailedMsg": "请检查网络",
    "dialogNetworkFailedConfirm": "确定",
    "dialogSDKErrTitle": "本次操作失败",
    "dialogSDKErrMsg": "抱歉，系统出错了，请再试一次",
    "dialogSDKErrConfirm": "确定"
  }
}

文案配置字段详细说明

模块	key	截图	补充说明
引导页 guideConfig	dialogExitTitle		手动退出弹框文案说明手动点击“X”（退出）或“暂不认证”时弹出。
	dialogExitMsg
	dialogExitConfirm
	dialogExitCancel
	dialogNetworkFailedTitle		网络异常弹框文案
	dialogNetworkFailedMsg
	dialogNetworkFailedConfirm
活体页 faceConfig	faceTitleBlink		刷脸页标题文案
	leftYawLiveness
	rightYawLiveness
	photinusCommTips
	faceNotFound		取景框内提示文案
	faceTooFar
	faceTooClose
	faceNotIn
	badPitch
	badYaw
	faceTooMore
	faceIsMoving
	faceBrightless
	faceBadQuality
	eyesOnScreen
	blink
	leftYaw
	rightYaw
	stackTime
	isBlur
	faceInitTxt
	processing		认证提交时loading文案
	dialogTooManyRetriesTitle		重试次数过多弹窗文案
	dialogTooManyRetriesMsg
	dialogTooManyRetriesConfirm
	dialogCamOpenFailedTitle		摄像头打开异常弹窗文案
	dialogCamOpenFailedMsg
	dialogCamOpenFailedConfirm
	dialogSDKErrTitle		操作失败弹窗文案
	dialogSDKErrMsg
	dialogSDKErrConfirm
	dialogNetworkFailedTitle		网络异常弹窗文案
	dialogNetworkFailedMsg
	dialogNetworkFailedConfirm
	dialogExitTitle		手动退出弹窗文案
	dialogExitMsg
	dialogExitConfirm
	dialogExitCancel
	dialogTimeOutTitle		操作超时弹窗文案
	dialogTimeOutMsg
	dialogTimeOutConfirm