开发准备
1. 注册腾讯云账号,单击进入 文字识别控制台,即可开通相应服务。
2. 在 账号中心 获取 API 密钥。
3. 前往文字识别客户端 SDK 接入页面 下载对应 SDK。
![](https://qcloudimg.tencent-cloud.cn/image/document/fd12d1625129d286b0609cf2343a3abc.png)
![](https://qcloudimg.tencent-cloud.cn/image/document/fd12d1625129d286b0609cf2343a3abc.png)
Harmony 端 OCR SDK 接入流程
Harmony 端OCR SDK 介绍
SDK 提供的文件为 OCR_Harmony_Public_SDK_3.x.x.x.har(具体版本号以 SDK 交付件为准),该文件封装了 OCR 识别终端能力。目前包括了身份证识别、银行卡识别、名片识别、车辆 Vin 码识别、车牌识别、驾驶证识别以及行驶证识别。
环境依赖
当前 Harmony 端 OCR 识别 SDK 适用于 API 11(Harmony Next 4.0)及以上版本。
接入步骤
1. 将OCR_Harmony_Public_SDK_3.x.x.x.har添加到您工程目录的 libs 目录下。
├── OcrHarmonyDemo│ ├── build-profile.json5│ ├── hvigorfile.ts│ ├── libs│ │ └── OCR_Harmony_Public_SDK_3.x.x.x.har <<<============== har包文件存放路径│ ├── oh-package.json5│ └── src│ └── main
2. 在您工程的 oh-package.json5 中进行配置修改,具体可以参考下面内容:
{"license": "","author": "","name": "HuiyanHarmonyDemo","description": "Please describe the basic information.","main": "","version": "1.0.0","dependencies": {// 添加依赖"OcrPublicSDK": "file:./libs/OCR_Harmony_Public_SDK_3.x.x.x.har",}}
SDK 接口使用说明
SDK 初始化:
使用 OCR SDK 之前需要进行初始化。
OcrSDKKit.getInstance().init(getContext());
目前 OCR SDK 支持的业务模式:
OcrModeType 类型 | 代表含义 |
OCR_DETECT_MANUAL | 手动拍摄模式 |
OCR_DETECT_AUTO_MANUAL | 自动识别模式(tips:20s后提示,是否切换到手动拍摄) |
更新临时密钥
OCR SDK 支持使用临时密钥接口,使用临时密钥的好处主要有以下两点,第一将固定密钥与终端分离可以增加安全性;第二因为兑换临时密钥是您完全可控的行为,因此您可以根据自定义规则来控制最终用户的接口访问权限。因此建议您使用临时密钥的方式,具体可以参考文档 (临时密钥文档与流程链接)
let fetch = new FetchToken() fetch.fetchToken(false) // 返回临时的secretID, secretKey, token
OCR 识别(返回 Json 字符串):
当您需要使用 OCR 识别的功能的时候,您可以直接调用识别接口,进行 OCR 业务识别。
// 启动 ocr 识别,识别类型为身份证正面let config: OcrSDKConfig = new OcrSDKConfigBuilder() .setOcrMode(this.ocrMode) .setAuto2ManualTimeout(this.timeout) .setCardType(ocrCardType) .setOcrUIConfig(uiConfig) .setSecretID(val[0]) .setSecretKey(val[1]) .setToken(val[2]) .build(); OcrSDKKit.getInstance().startOcrByConfig(config, { onSuccess: (response: string, requestID: string, imgBase64: string) => {// 成功 }, onFail: (errorCode: number, errMsg: string) => { // 失败 } });
SDK 资源释放:
在您 App 退出使用或者需要重启加载 OCR 功能的时候,可以调用 SDK 资源释放接口。
OcrSDKKit.getInstance().release();