aip-ocr-harmonyos-sdk.zip   // OCR SDK 包，包括文档、sample 工程、SDK 核心库
|- sample/                      // sample 示例工程
|- libs/                        // lib 库，包括 .har 包
|  |- ocr-core.har              // 核心模块
|  |- ocr-online.har            // 在线识别能力模块
|- docs/                        // 说明文档

{
  "dependencies": {
    "@baidu/ocr-core": "file:./libs/ocr-core.har",
    "@baidu/ocr-online": "file:./libs/ocr-online.har"
  }
}

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

# 通过 API Key + Secret Key 换取的 token
access_token=YOUR_REAL_ACCESS_TOKEN

const options = new OcrOptions();
options.putParam(OnlineAuthParams.IAM_API_KEY, 'your_iam_api_key');

await OnlineOcrClient.getInstance().initializeAsync(context, options);

import common from '@ohos.app.ability.common';
import {
  OnlineOcrClient, OcrOptions, OcrInitResult,
  OnlineAuthParams
} from '@baidu/ocr-core';
import '@baidu/ocr-online';

async function initOcrSdk(context: common.Context, accessToken: string): Promise<void> {
  const options = new OcrOptions();
  options.putParam(OnlineAuthParams.ACCESS_TOKEN, accessToken);

  const result: OcrInitResult = await OnlineOcrClient.getInstance()
    .initializeAsync(context, options);

  console.info(`OCR SDK 初始化完成，支持 ${result.getSupportedTypes().length} 种能力`);
}

const options = new OcrOptions();
options.putParam(OnlineAuthParams.API_KEY, 'your_api_key');
options.putParam(OnlineAuthParams.SECRET_KEY, 'your_secret_key');

await OnlineOcrClient.getInstance().initializeAsync(context, options);

const options = new OcrOptions();
options.putParam(OnlineAuthParams.AUTH_TOKEN_PROVIDER, 'your_provider_identifier');

await OnlineOcrClient.getInstance().initializeAsync(context, options);

import {
  OcrInitParams, OnlineAuthParams, OnlineOcrTypes
} from '@baidu/ocr-core';
import { IdCardInitParams } from '@baidu/ocr-online';

const options = new OcrOptions();
// 先设置在线 API 鉴权（4 种方式选一）
options.putParam(OnlineAuthParams.ACCESS_TOKEN, 'your_token');

// 再设置身份证质量检测 License（仅使用身份证时需要）
const idCardInit = new OcrInitParams();
idCardInit.putParam(IdCardInitParams.LICENSE_KEY, 'your_license_key');
idCardInit.putParam(IdCardInitParams.LICENSE_NAME, context.resourceDir + '/ocr_license.ini');
idCardInit.params.set(IdCardInitParams.LICENSE_IS_REMOTE, true);
idCardInit.putParam(IdCardInitParams.RESOURCE_DIR_PATH, context.resourceDir + '/baiducard');

options.initParams.set(OnlineOcrTypes.ID_CARD_FRONT.value(), idCardInit);
options.initParams.set(OnlineOcrTypes.ID_CARD_BACK.value(), idCardInit);

await OnlineOcrClient.getInstance().initializeAsync(context, options);

initializeAsync(context, options)
  |
  v
按优先级选取在线 API 鉴权方式
  |
  +-> IAM_API_KEY 存在？使用 IAM Bearer 鉴权
  |
  +-> ACCESS_TOKEN 存在？直接使用该 token
  |
  +-> API_KEY + SECRET_KEY 存在？SDK 内部换取 token
  |
  +-> AUTH_TOKEN_PROVIDER 存在？调用自定义提供器
  |
  +-> 均未配置？抛出 AUTH_ERROR
  |
  v
注册识别能力（身份证 License 在此阶段校验）
  |
  +-> initParams 中有身份证 License：初始化质量检测模型
  |     +-> 成功：身份证自动采集可用
  |     +-> 失败：身份证退回手动拍照（其他类型不受影响）
  |
  +-> 无身份证 License：跳过（其他类型正常可用）

import {
  OnlineOcrClient, OcrType, OcrError, OcrJSONCallback,
  OcrCaptureOptions, CaptureMode
} from '@baidu/ocr-core';
import { OnlineOcrTypes, IdCardParams } from '@baidu/ocr-online';

function scanIdCard(abilityContext: common.UIAbilityContext): void {
  const captureOptions = new OcrCaptureOptions();
  captureOptions.setCaptureMode(CaptureMode.AUTO);

  const params = new IdCardParams();

  OnlineOcrClient.getInstance().scanForJSON(
    abilityContext,
    OnlineOcrTypes.ID_CARD_FRONT,
    captureOptions,
    params,
    {
      onSuccess(responseJSON: string): void {
        // responseJSON 为服务端完整 JSON 响应
        console.info('识别成功: ' + responseJSON);
      },
      onFailure(error: OcrError): void {
        console.error(`识别失败: code=${error.code}, message=${error.message}`);
      },
      onCanceled(): void {
        console.info('用户取消');
      }
    } as OcrJSONCallback
  );
}

OnlineOcrClient.getInstance().release();