金融級實人認證服務Android SDK提供自定義UI顏色、icon圖標和UI文案的接口,開發者可以通過調用setCustomUIConfig
或setCustomTxtConfig
接口進行自定義。本文為您介紹UI自定義接口說明以及相關的代碼示例。
部分自定義配置可能需要依賴SDK升級,建議您在使用之前將SDK升級至最新版本。
自定義UI顏色和icon圖標
目前僅支持自定義引導頁和活體認證頁的顏色和icon圖標。
接口說明
Android SDK中提供了自定義UI顏色和icon圖標的接口:setCustomUIConfig
。
/**
* @description 此接口用于設置自定義UI。
* @param {int} paramType 參數類型,可傳范圍(
* ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME
* /ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH
* /ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON)。
* @param {String} param 參數值,paramType相對應的值。
* @return 配置文件檢測出的異常信息。
*/
public String setCustomUIConfig(int paramType, String param) {
...
}
參數說明:
名稱
類型
說明
paramType
int
配置自定義入參的類型:
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME:
傳入App assets文件類型,param需要傳入assets文件名稱。
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH:
傳入設備本地路徑,params需要傳入配置文件的設備絕對路徑地址。
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON:
傳入JSON字符串,params需傳入JSON格式的數據。
param
String
與paramType配套調用。
返回值:String類型,當SDK對param內容解析遇到錯誤或出現異常信息時會通過提示信息的方式返回。當配置參數無效時,請重點關注返回值信息。
示例代碼
//傳入文件路徑
File file = new File(getFilesDir() + "/dtf/config_test/DTFConsumUIConfig.json");
String path = file.getAbsolutePath();
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH;
customUIErrMsg = zimFacade.setCustomUIConfig(paramType, path);
//傳入assets文件名
String fileName = "DTFConsumUIConfig.json";
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME;
customUIErrMsg = zimFacade.setCustomUIConfig(paramType, fileName);
//傳入JSON字符串
String jsonConfig="";
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON;
customUIErrMsg = zimFacade.setCustomUIConfig(paramType, jsonConfig);
字段定義
字段列表
{
"guideConfig": {
"titleColor": "#111111",
"titleBackPath": "",
"titleBackBase64": "",
"titleClosePath": "",
"titleCloseBase64": "",
"bannerImg": "",
"agrtUnSelColor": "#c5c5c5",
"agrtSelBgColor": "#ff6a00",
"agrtAgreeColor": "#333333",
"agrtColor": "#ff6a00",
"startBtnColor": "#ffffff",
"agrtBotTipsColor": "#333333",
"startBtnDisColor": "#ffffff",
"startBtnBgColor": "#ff6a00",
"startBtnDisBgColor": "#d9d9d9",
"elderBtnDisColor": "#ffffff",
"elderBtnBgColor": "#f0f0f0",
"elderBtnDisBgColor": "#d9d9d9",
"exitBtnColor": "#333333",
"exitBtnBgColor": "#ffffff",
"elderBtnColor": "#ff6a00",
"rareFormEntBtnColor": "#ff6a00",
"permissionToastBgColor": "#ffffff",
"permissionToastTitleColor": "#000000",
"permissionToastMsgColor": "#000000",
"dialogExitTitleColor": "#000000",
"dialogExitMsgColor": "#000000",
"dialogExitCancelColor": "#0E83E6",
"dialogExitConfirmColor": "#0E83E6",
"dialogPermissionFailedTitleColor": "#000000",
"dialogPermissionFailedMsgColor": "#000000",
"dialogPermissionFailedConfirmColor": "#0E83E6",
"dialogSupportFailedTitleColor": "#000000",
"dialogSupportFailedMsgColor": "#000000",
"dialogSupportFailedConfirmColor": "#0E83E6",
"dialogNetworkFailedTitleColor": "#000000",
"dialogNetworkFailedMsgColor": "#000000",
"dialogNetworkFailedConfirmColor": "#0E83E6"
},
"faceConfig": {
"faceBgColor": "#FFFFFF",
"faceTitleColor": "#000000",
"circleTxtBgAlpha": "0.25",
"dialogBgAlpha": "0.25",
"faceProgressStartColor": "#dfe6eb",
"faceProgressEndColor": "#FF6A00",
"circleTxtColor": "#ffffff",
"exitIconPath": "",
"exitIconBase64": "",
"submitTextColor": "#E4E4E4",
"submitLoadingIconBase64": "",
"submitLoadingIconPath": "",
"dialogExitTitleColor": "#000000",
"dialogExitMsgColor": "#000000",
"dialogExitCancelColor": "#0E83E6",
"dialogExitConfirmColor": "#0E83E6",
"dialogTimeOutTitleColor": "#000000",
"dialogTimeOutMsgColor": "#000000",
"dialogTimeOutConfirmColor": "#0E83E6",
"dialogNetworkFailedTitleColor": "#000000",
"dialogNetworkFailedMsgColor": "#000000",
"dialogNetworkFailedConfirmColor": "#0E83E6",
"dialogArchSysFailedTitleColor": "#000000",
"dialogArchSysFailedMsgColor": "#000000",
"dialogArchSysFailedConfirmColor": "#0E83E6",
"dialogTooManyRetriesTitleColor": "#000000",
"dialogTooManyRetriesMsgColor": "#000000",
"dialogTooManyRetriesConfirmColor": "#0E83E6",
"dialogInterruptTitleColor": "#000000",
"dialogInterruptMsgColor": "#000000",
"dialogInterruptConfirmColor": "#0E83E6",
"dialogInterruptCancelColor": "#0E83E6",
"dialogSDKErrTitleColor": "#000000",
"dialogSDKErrMsgColor": "#000000",
"dialogSDKErrConfirmColor": "#0E83E6",
"dialogCamOpenFailedTitleColor": "#000000",
"dialogCamOpenFailedMsgColor": "#000000",
"dialogCamOpenFailedConfirmColor": "#0E83E6",
"dialogCamOpenFailedCancelColor": "#0E83E6",
"noticeIconPath": "",
"noticeIconBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAKKADAAQAAAABAAAAKAAAAAB65masAAAEgElEQVRYCc1ZW2gVVxRd10d9pcVXo0arxkiKGlFr/bAgCPql+IoRW1pBabUqSqXQ74mW9qP40VJKWxFLERVFjREjih8qfuiHQUQtWiMK1sQY2oqPpL4yXevee8zM3Jm558abeDdszpmzH2fNnjP77DOTQCfJdd0ymi4iTyeXeJhdNHq4nv3aRCJxQ4IuJYIqJm8hXyLnSrKRbXHeQdJpEdkhPyS/KsmHQy7KC1A6qiTfJeeb5LOy0yBpnCA75HZyV5F8O+RETkBp0I+8j9xdpLn6WYGkoiLXneBMEDRn9khSyTEWubRtz1z3m2Ou++UB121oycXSp+sEo+hDTFUt2v1k33jQKHjd9ABYtRO4cDslKeoDfF8FLJgc1Mx67VKjijnzoNF8CYTg9No3kIcZYbb20RNgz3nguxPAg/8ytRdPAb6aC4x/O1MWM9JM2XiCfCQdL0CFt1qDQXrRDtRdAS7+BbTzHv9pBW60AFeagNanQe3M63Km5nLe9oi3gL69gSEDgGXvAUPZRlA1AW6WLAmQ0VN211YUmjx/PkPkdVLPH70/mje9PtKfoldGkPd6pFU2sg0FJ/k1BT3P9Oe9WIfCskEaBuDiWPXXI1ySBMjHq6qk4vVgiJ21QtgUQZVMXUbvDAJObQIOr+3UFIsEUPVcLPXuGSuOFJYOTQGbMDzzbbf0Ob0XvavYjKX+b8SKQ4VKLQdWA8VvAmdvAp/u8qtZ+ixRBLMCHBAC8LcVgFi7RpAmjQAOfZ4Cd/o68NEO4DGTupfCfHrl6b4dwJKBftMEs2cZd4d5k7gvMkoD+3fIp44CDq5JJeMTV4EVvwNtzzrkphf0acYDbRKg9r9YGjvYL3Zpoajc+huYJkAEqd1hxhgC/oyAWTgd5c6j/fnJc7+tuSodYnqxras1yA0LXCnRNJGPTFETMEN37gMLf02tMz3SI+uA4dzKtLZqLjLL7gOevzDama1sLKhJa7Axm+JgPkIt+iA1s4pZQpB/3AXG8Y0VuL31wPq98eDkZ2Zp0FvodaMVQJnOeTfUAVq4a1ZuSz3SH04CX+xnQcHiIo7G8vHqhiwoCZD3nJ2WTo3W+bc1td6+Pe5fBlEWVdOiJBnj9YpgbcZwyEAFk9Hs8hBBjkNKS6tmWhvV9mBJozLrso2JM4/VhW7pFWjj7Ng60Ov5srCZ6Wq8kqj+RG5Zy1lodpZGMp+unWVtncTE5KF1E1+wel0+fsrqgm/upTve0ex97Rw13F2mjMyuSw2+ep6CVZUrB7bamGqi3SsBVSm21IvFxvZPrMHJ7dY0Jt+ZpIiCBrLVoan5IbBmN3DupvxF0zAm718+BD4YF60TkKh+zzw0SYmPupINM1kHcI1HkQ5TP54GfiIHT3V6mZSaqudbvxSaRntV+LHTgCBIh/1qc23T3m9LHT/rmAtUtSgdfTwj5+Ompnp5mouclwAL+9OHkBNk4X48MqFNR9JhW3if3wzIdDQL8wNmAGThfgIOANVH9K/J3fYRPbnVeUHY9glSB36dqXVs1cHLMLv5+w3xPyaCG6DbMlfXAAAAAElFTkSuQmCC",
"noticeTxtColor": "#1677FF",
"noticeBgColor": "#0F1677FF"
}
}
字段詳細說明
展開折疊面板查看字段詳細說明。
自定義UI顏色和icon字段詳細說明
模塊 | key | 示例圖 | 說明 |
guideConfig(引導頁) | titleColor | 標題刷臉認證字體顏色。 示例值“#111111”。 | |
agrtTopTipsColor | 協議頂部提示文本顏色。 示例“#111111”。 | ||
bannerImg | 示例圖。 僅可配置圖片的本地路徑。支持Base64格式(需要固定開頭,例如:“data:image/jpeg;base64,/9j...”)。 說明
| ||
agrtUnSelColor | 勾選框未選中顏色。 | ||
agrtSelBgColor | 勾選框選中顏色。 | ||
agrtAgreeColor | 同意字體顏色。 | ||
agrtColor | 《認證服務協議》顏色。 | ||
agrtBotTipsColor | 同意認證后,……顏色。 | ||
startBtnBgColor | 開始認證按鈕背景顏色。 | ||
startBtnDisBgColor | 未選中同意時,即按鈕不可用狀態下開始認證按鈕的背景顏色。 | ||
startBtnDisColor | 未選中同意時,即按鈕不可用狀態下開始認證按鈕的文字顏色。 | ||
startBtnColor | 開始認證按鈕字體顏色。 | ||
exitBtnBgColor | 暫不認證按鈕背景顏色。 | ||
exitBtnColor | 暫不認證按鈕字體顏色。 | ||
elderBtnColor | 長輩模式認證按鈕字體顏色。 | 適老化(選擇)模式。 | |
elderBtnBgColor | 長輩模式認證按鈕背景顏色。 | ||
elderBtnDisBgColor | 長輩模式認證按鈕禁用(暫不可點擊)背景顏色。 | ||
rareFormNameColor | 生僻字模式,姓名字體顏色。 | 生僻字模式。 | |
rareFormIDColor | 生僻字模式,身份證號字體顏色。 | ||
rareFormEntBtnColor | 生僻字模式,錄入生僻字按鈕文本顏色。 | ||
titleBackPath | 無。 | 標題欄返回icon圖標。 路徑優先級低于Base64編碼。 | |
titleBackBase64 | |||
titleClosePath | 標題欄關閉icon圖標。 路徑優先級低于Base64編碼。 | ||
titleCloseBase64 | |||
permissionToastTitleColor | 權限兜底toast的標題字體顏色。 | ||
permissionToastMsgColor | 權限兜底toast的內容字體顏色。 | ||
permissionToastBgColor | 權限兜底toast背景顏色。 | ||
dialogPermissionFailedTitleColor | 權限拒絕彈框配色。 | ||
dialogPermissionFailedMsgColor | |||
dialogPermissionFailedConfirmColor | |||
dialogSupportFailedTitleColor | 系統/架構不支持彈框配色。 | ||
dialogSupportFailedMsgColor | |||
dialogSupportFailedConfirmColor | |||
dialogNetworkFailedTitleColor | 網絡異常彈框配色。 | ||
dialogNetworkFailedMsgColor | |||
dialogNetworkFailedConfirmColor | |||
dialogExitTitleColor | 退出彈窗配色。 | ||
dialogExitMsgColor | |||
dialogExitCancelColor | |||
dialogExitConfirmColor | |||
faceConfig(刷臉頁) | faceBgColor | 刷臉頁背景色。 | |
faceTitleColor | 刷臉頁標題字體顏色。 | ||
faceProgressStartColor | 取景框(環形進度條)顏色起始色值。 | ||
faceProgressEndColor | 取景框(環形進度條)顏色終止色值。 | ||
circleTxtBgAlpha | 蒙層不透明度。 取值范圍(0,1)。 | ||
circleTxtColor | 蒙層上方文案顏色。 | ||
dialogBgAlpha | 彈窗背景蒙層不透明度。 取值范圍:(0,1)。 | ||
exitIconPath | 退出圖標路徑。 | ||
exitIconBase64 | 退出icon圖片Base64編碼。 | ||
submitTextColor | 認證提交loading提示文案字體顏色。 | ||
submitLoadingIconBase64 | loading圖標Base64編碼。 | ||
submitLoadingIconPath | loading圖標路徑。 | ||
dialogExitTitleColor | 退出彈框配色。 | ||
dialogExitMsgColor | |||
dialogExitCancelColor | |||
dialogExitConfirmColor | |||
dialogTimeOutTitleColor | 操作超時彈框配色。 | ||
dialogTimeOutMsgColor | |||
dialogTimeOutConfirmColor | |||
dialogNetworkFailedTitleColor | 網絡異常彈窗配色。 | ||
dialogNetworkFailedMsgColor | |||
dialogNetworkFailedConfirmColor | |||
dialogSDKErrTitleColor | 操作失敗彈窗配色。 | ||
dialogSDKErrMsgColor | |||
dialogSDKErrConfirmColor | |||
dialogTooManyRetriesTitleColor | 重試過多彈框配色。 | ||
dialogTooManyRetriesMsgColor | |||
dialogTooManyRetriesConfirmColor | |||
dialogInterruptTitleColor | 驗證中斷彈窗配色。 | ||
dialogInterruptMsgColor | |||
dialogInterruptConfirmColor | |||
dialogInterruptCancelColor | |||
dialogArchSysFailedTitleColor | 系統/架構不支持彈窗配色。 | ||
dialogArchSysFailedMsgColor | |||
dialogArchSysFailedConfirmColor | |||
dialogCamOpenFailedTitleColor | 攝像頭打開異常彈窗配色。 | ||
dialogCamOpenFailedMsgColor | |||
dialogCamOpenFailedConfirmColor | |||
noticeIconPath | 業務提示圖標路徑。 需要打開SDK對應開關才會顯示該配置。代碼示例,請參見打開刷臉頁業務提示開關示例代碼。 | ||
noticeIconBase64 | 業務提示圖標Base64格式。 需要打開SDK對應開關才會顯示該配置。代碼示例,請參見打開刷臉頁業務提示開關示例代碼。 | ||
noticeTxtColor | 業務提示文案顏色。 需要打開SDK對應開關才會顯示該配置。代碼示例,請參見打開刷臉頁業務提示開關示例代碼。 | ||
noticeBgColor | 業務提示區域背景色。 需要打開SDK對應開關才會顯示該配置。代碼示例,請參見打開刷臉頁業務提示開關示例代碼。 |
打開刷臉頁業務提示開關示例代碼如下:
ZIMFacade zimFacade = ZIMFacadeBuilder.create(MainActivity.this);
HashMap<String, String> extParams = new HashMap<>();
//如需打開刷臉頁業務提示開關(默認可不設置),請設置此項,需要結合自定義UI的配置文件使用
extParams.put(ZIMFacade.ZIM_EXT_PARAMS_KEY_NEED_FACE_NOTICE, ZIMFacade.ZIM_EXT_PARAMS_VAL_NEED_FACE_NOTICE_TRUE);
zimFacade.verify(certifyId, true, extParams, new ZIMCallback() {
@Override
public boolean response(final ZIMResponse response) {
return true;
}
});
自定義UI文案
目前僅支持自定義引導頁和活體認證頁的展示文案。
接口說明
SDK中提供了自定義UI文案的接口:setCustomTxtConfig
。
/**
* @description 設置自定義UI。
* @param {int} paramType 參數類型,可傳范圍(ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME
* /ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH
* /ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON)
* @param {String} params 參數值,paramType相對應的值
* @return 配置文件檢測出的異常信息。
*/
public String setCustomTxtConfig(int paramType, String param) {
...
}
參數說明
名稱
類型
說明
paramType
int
配置自定義入參的類型,可選值:
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME:
傳入App assets文件類型,param需要傳入assets文件名稱。
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH:
傳入設備本地路徑,params需要傳入配置文件的設備絕對路徑地址。
ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON:
傳入JSON字符串,params傳入JSON格式的數據。
param
String
與paramType配套調用。
返回值:String類型,當SDK對param內容解析遇到錯誤或出現異常信息時會通過提示信息的方式返回。當配置參數無效時,請重點關注返回值信息。
示例代碼
//傳入文件路徑
File file = new File(getFilesDir() + "/dtf/config_test/DTFConsumTxtConfig.json");
String path = file.getAbsolutePath();
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_PATH;
customUIErrMsg = zimFacade.setCustomTxtConfig(paramType, path);
//傳入assets文件名
String fileName = "DTFConsumTxtConfig.json";
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_ASSETS_NAME;
customUIErrMsg = zimFacade.setCustomTxtConfig(paramType, fileName);
//傳入json字符串
String jsonConfig="";
int paramType = ZIMFacade.ZIM_EXT_PARAMS_VAL_ZIM_EXT_PARAMS_CONFIG_FILE_JSON;
customUIErrMsg = zimFacade.setCustomTxtConfig(paramType, jsonConfig);
字段定義
字段列表
{
"guideConfig": {
"titleText": "刷臉認證",
"agrtTopTipsText": "請先勾選協議",
"agrtAgreeText": "同意",
"agrtText": "《認證服務協議》",
"agrtBotTipsText": "同意認證后,將獲取您的攝像頭權限用于人臉識別驗證身份",
"startBtnText": "開始認證",
"elderBtnText": "長輩模式認證",
"exitBtnText": "暫不認證",
"authPermissionSDKName": "實人認證",
"authPermissionAPPName": "阿里云實人認證",
"authPermissionCamera": "相機",
"authPermissionAudio": "錄音",
"authPermissionScreenEvidence": "錄屏",
"authPermissionToastTitle": "",
"authPermissionToastMsg": "",
"dialogExitTitle": "確定退出嗎?",
"dialogExitMsg": "露個臉就能通過",
"dialogExitConfirm": "確定",
"dialogExitCancel": "取消",
"dialogPermissionFailedTitle": "認證失敗",
"dialogPermissionFailedMsg": "請確認相關權限已開啟后再次發起",
"dialogPermissionFailedConfirm": "確認",
"dialogNetworkFailedTitle": "網絡不給力",
"dialogNetworkFailedMsg": "請檢查網絡",
"dialogNetworkFailedConfirm": "確定",
"dialogSupportFailedTitle": "當前系統不支持刷臉",
"dialogSupportFailedMsg": "刷臉僅在高版本及以上系統可用",
"dialogSupportFailedConfirm": "確定"
},
"faceConfig": {
"faceNotFound": "沒有檢測到臉",
"faceTooFar": "靠近一點",
"faceTooClose": "離遠一點",
"faceNotIn": "把臉移入圈內",
"badPitch": "請正對手機",
"badYaw": "請正對手機",
"faceTooMore": "請保持單人操作",
"faceIsMoving": "再清晰一點",
"faceBrightless": "臉部亮一點",
"faceBadQuality": "請露出正臉",
"eyesOnScreen": "請注視屏幕",
"blink": "眨眨眼",
"leftYaw": "向左搖頭",
"rightYaw": "向右搖頭",
"stackTime": "請保持不動",
"isBlur": "再清晰一點",
"hasHat" : "請摘掉帽子",
"faceOcclusion" : "請移除遮擋"
"faceInitTxt": "請正對屏幕",
"faceTitleBlink": "拿起手機,眨眨眼",
"leftYawLiveness": "拿起手機,向左搖頭",
"rightYawLiveness": "拿起手機,向右搖頭",
"photinusCommTips": "請把臉移入圈內保持不動",
"qualityTitle": "勿遮擋、傾斜、逆光拍攝",
"processing": "正在處理",
"dialogTimeOutTitle": "操作超時",
"dialogTimeOutMsg": "正對手機,更容易成功",
"dialogTimeOutConfirm": "再試一次",
"dialogInterruptTitle": "驗證中斷",
"dialogInterruptConfirm": "再試一次",
"dialogInterruptCancel": "退出",
"dialogTooManyRetriesTitle": "本次操作失敗",
"dialogTooManyRetriesMsg": "刷臉失敗次數過多,請稍后再試",
"dialogTooManyRetriesConfirm": "我知道了",
"dialogExitTitle": "確定退出嗎?",
"dialogExitMsg": "露個臉就能通過",
"dialogExitConfirm": "確定",
"dialogExitCancel": "取消",
"dialogCamOpenFailedTitle": "攝像頭打開異常",
"dialogCamOpenFailedMsg": "請重啟app或手機后再次嘗試",
"dialogCamOpenFailedConfirm": "確定",
"dialogCamOpenFailedCancel": "取消",
"dialogArchSysFailedTitle": "當前系統不支持刷臉",
"dialogArchSysFailedMsg": "刷臉僅在高版本及以上系統可用",
"dialogArchSysFailedConfirm": "確定",
"dialogSDKErrTitle": "本次操作失敗",
"dialogSDKErrMsg": "抱歉,系統出錯了,請再試一次",
"dialogSDKErrConfirm": "確定",
"dialogNetworkFailedTitle": "網絡不給力",
"dialogNetworkFailedMsg": "請檢查網絡",
"dialogNetworkFailedConfirm": "確定",
"verifyNotice": "您正在進行實人認證,請確保本人操作!"
}
}
字段詳細說明
展開折疊面板查看字段詳細說明。
自定義UI文案字段詳細說明
模塊 | key | 截圖 | 補充說明 |
guideConfig(引導頁) | titleText | 刷臉認證文案。 | |
agrtTopTipsText | 默認不顯示,未勾選同意,點擊開始認證時顯示。 | ||
agrtAgreeText | 同意文案。 | ||
agrtText | 《認證服務協議》文案。 | ||
agrtBotTipsText | 同意認證后,……文案。 | ||
startBtnText | 開始認證按鈕文案。 | ||
elderBtnText | 長輩模式認證按鈕文案。 默認不顯示,啟用適老化選擇模式時,顯示此按鈕。 | ||
exitBtnText | 暫不認證文案。 | ||
rareFormNameText | 生僻字模式顯示。具體文案參見左圖示例。 | ||
rareFormIDText | |||
rareFormEntBtnText | |||
authPermissionToastTitle | 兜底權限提示toast標題文案。 沒有注入ZIMUICustomListener或onPermissionRequest方法返回False且傳參ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST值為ZIMFacade.ZIM_EXT_PARAMS_VAL_NEED_PERMISSION_TOAST_TRUE,在請求權限時,SDK兜底顯示該提示toast。 | ||
authPermissionToastMsg | 兜底權限提示toast內容文案。 | ||
authPermissionCamera | 申請的是“相機權限”時顯示的文案。 | ||
authPermissionAudio | 申請的是“錄音權限”時顯示的文案。 | ||
authPermissionScreenEvidence | 申請的是“錄屏權限”時顯示的文案。 | ||
authPermissionAPPName | 兜底toast中顯示的“應用名稱”。 如果未配置,則顯示獲取到的App名稱。 為確保您能使用 | ||
authPermissionSDKName | 兜底toast中顯示的“SDK名稱”。 如果未配置,則顯示SDK名稱。 為確保您能使用 | ||
dialogExitTitle | 手動退出彈框文案。 手動點擊“X”(退出)/“暫不認證”時。 | ||
dialogExitMsg | |||
dialogExitConfirm | |||
dialogExitCancel | |||
dialogPermissionFailedTitle | 權限拒絕彈框文案。 | ||
dialogPermissionFailedMsg | |||
dialogPermissionFailedConfirm | |||
dialogNetworkFailedTitle | 網絡異常彈框文案。 | ||
dialogNetworkFailedMsg | |||
dialogPermissionFailedConfirm | |||
dialogSupportFailedTitle | 系統/架構不支持彈框文案。 | ||
dialogSupportFailedMsg | |||
dialogSupportFailedConfirm | |||
faceConfig(刷臉頁) |
| 刷臉頁標題文案。 | |
| 取景框內提示文案。 | ||
processing | 認證提交時loading文案。 | ||
dialogInterruptTitle | 驗證中斷彈窗文案。 | ||
dialogInterruptConfirm | |||
dialogInterruptCancel | |||
dialogTooManyRetriesTitle | 重試次數過多彈窗文案。 | ||
dialogTooManyRetriesMsg | |||
dialogTooManyRetriesConfirm | |||
dialogCamOpenFailedTitle | 攝像頭打開異常彈窗文案。 | ||
dialogCamOpenFailedMsg | |||
dialogCamOpenFailedConfirm | |||
dialogArchSysFailedTitle | 系統/架構不支持彈窗文案。 | ||
dialogArchSysFailedMsg | |||
dialogArchSysFailedConfirm | |||
dialogSDKErrTitle | 操作失敗彈窗文案。 | ||
dialogSDKErrMsg | |||
dialogSDKErrConfirm | |||
dialogNetworkFailedTitle | 網絡異常彈窗文案。 | ||
dialogNetworkFailedMsg | |||
dialogNetworkFailedConfirm | |||
dialogExitTitle | 手動退出彈窗文案。 | ||
dialogExitMsg | |||
dialogExitConfirm | |||
dialogExitCancel | |||
dialogTimeOutTitle | 操作超時彈窗文案。 | ||
dialogTimeOutMsg | |||
dialogTimeOutConfirm | |||
verifyNotice | 業務提示文案。 需要打開SDK對應開關才會顯示。示例如下:
|
合規權限提醒
SDK為了保證基礎功能的運行需要向客戶申請對應功能的權限,為了保證您的應用對客戶展示合規,SDK內部提供了權限獲取以及使用說明提醒彈窗,該功能默認關閉,當您需要使用時請通過verify接口進行開啟。
開關接口
接口說明
請參考對應方案的Verify接口函數定義。
名稱 | 說明 | 類型 |
params_key_need_permission_toast | SDK獲取權限時是否需要彈窗說明權限目的,僅當設置為true時SDK會彈窗。 | true |
params_key_need_permission_toast_duration | 權限toast持續時間,單位毫秒。需要同時打開SDK權限提醒toast開關。 | 2000 |
示例代碼
HashMap<String, String> extParams = new HashMap<>();
//如獲取權限時需要SDK彈出權限提醒toast,請設置此項
extParams.put(ZIMFacade.ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST, ZIMFacade.ZIM_EXT_PARAMS_VAL_NEED_PERMISSION_TOAST_TRUE);
//如想修改SDK權限提醒toast的顯示持續時間,請設置此項,單位為毫秒
extParams.put(ZIMFacade.ZIM_EXT_PARAMS_KEY_NEED_PERMISSION_TOAST_DURATION, "2000");
zimFacade.verify(certifyId, true, extParams, new ZIMCallback() {
@Override
public boolean response(ZIMResponse response) {
if (null != response && 1000 == response.code) {
// 認證成功
Toast.makeText(getApplicationContext(),
"認證成功\n" +
"code: " + response.code + "\n" +
"reason: " + response.reason,
Toast.LENGTH_LONG).show();
} else {
// 認證失敗
Toast.makeText(getApplicationContext(),
"認證失敗\n" +
"code: " + response.code + "\n" +
"reason: " + response.reason,
Toast.LENGTH_LONG).show();
}
return true;
}
});
彈窗自定義接口
當Android SDK默認的彈框不足以滿足業務訴求時,您可以通過ZIMUICustomListener接口自定義彈窗能力。
接口說明
/**
* 設置UI自定義回調
* @param uiListener
*/
public void setCustomUIListener(ZIMUICustomListener uiListener) {
....
}
public interface ZIMUICustomListener {
......
/**
* SDK請求權限時回調通知
* @return 是否實現權限提示彈窗
*/
boolean onPermissionRequest(Activity activity, List<String> requestPerms, String verifyType);
}
參數說明
名稱
類型
說明
activity
Activity
當前請求權限的Activity。
requestPerms
List<String>
當前請求權限的列表。
verifyType
String
當前請求權限的業務。
FACE:活體業務。
OCR:證件業務。
WISH:多因子意愿業務。
返回值:bool類型。當您需要自行處理彈窗時,返回設置為true;若需要默認彈窗,則返回值設置為false。
示例代碼
/**
* @return 是否實現權限提示彈窗
*/
zimFacade.setCustomUIListener(new ZIMUICustomListener() {
...
@Override
public boolean onPermissionRequest(Activity activity, List<String> requestPerms, String verifyType) {
Toast.makeText(activity, "PermissionRequest", Toast.LENGTH_SHORT).show();
return true;
}
});=