Android API 概览

Android 端文字识别 SDK 主要涉及的类有 OcrSDKKit、OcrSDKConfig、OcrType、OcrModeType、ISDKKitResultListener、ISdkOcrEntityResultListener 以及 OCR 识别返回实体类，下面对其支持的 API 做出详细说明。

OcrSDKKit

OcrSDKKit 是文字识别 OCR 的对外接口类，文字识别功能主要集中在这个类中。

getInstance()

public static OcrSDKKit getInstance()

• 功能描述：
  创建 OcrSDKKit 的单例。
• 返回结果：
  OcrSDKKit 的单例对象。

release()

public void release()

• 功能描述：
  主动释放资源的方法，可在退出应用或者需要清理资源的时候调用。

getVersion()

public final String getVersion() 

• 功能描述：
  获取 SDK 当前的版本号。
• 返回结果：
  当前 SDK 的版本信息。

initWithConfig()

public void initWithConfig(Context context, OcrSDKConfig config)

• 功能描述：
  初始化 SDK 信息。
• 传入参数：

updateFederationToken()

public void updateFederationToken(final String tmpSecretId, final String tmpSecretKey,final String token)

• 功能描述：
  主动更新临时密钥信息，在您与服务器兑换得到临时密钥之后主动调用设置。
• 传入参数：

startProcessOcr()

public void startProcessOcr(Activity activity, OcrType ocrType, CustomConfigUi customConfigUi, ISDKKitResultListener resultListener)

• 功能描述：
  启动默认界面进行 OCR 识别，可进行部分 UI 元素的自定义配置。(如 CustomConfigUi 传入 null，可使用默认 UI 配置)
• 传入参数：

startProcessOcrResultEntity()

public <T extends OcrResult> void startProcessOcrResultEntity(Activity activity, OcrType ocrType,CustomConfigUi customConfigUi, Class<T> entity,ISdkOcrEntityResultListener<T> ocrEntityResultListener) 

• 功能描述：
  启动默认界面进行 OCR 识别，可进行部分 UI 元素的自定义配置。(如 CustomConfigUi 传入 null，可使用默认 UI 配置)，根据指定不同的识别模式返回不同识别结果类型实体。
• 传入参数：

OCR 识别结果的实体类，OCR 识别识别结果 OcrResult 的子类型包括：

IdCardOcrResult、BankCardOcrResult、BusinessCardOcrResult、MalaysiaIdCardOcrResult、VinOcrResult、CarLicensePlateResult、DriverLicenseCardResult、VehicleLicenseCardResult

OcrSDKConfig

OcrSDKConfig 是在 OCR 初始化时需要传入的 SDK 的配置信息实体类，采用构建者 builder 的方式进行参数配置。

支持参数及其默认值如下：

OcrType

OcrType 是一个枚举类型，列举了当前文字识别 OCR 的 SDK 所支持业务类型的种类，大致如下：

OcrModeType

OcrModeType 是一个枚举类型，列举了卡片识别模式

CustomConfigUi

此为用户自定义 UI 的配置类，当前支持配置的属性如下表所示，可以通过 javabean set 的方式设置。

IdCardOcrResult

身份证 OCR 识别的结果实体对象

BankCardOcrResult

银行卡 OCR 识别的结果实体对象

BusinessCardOcrResult

名片 OCR 识别的结果实体对象，主要包含一些列的 BusinessCardItems 对象。

BusinessCardItems

名片 OCR 识别的基本元素，包括名称与信息。

MalaysiaIdCardOcrResult

马来身份证 OCR 识别的结果实体对象

VinOcrResult

车辆的 VIN 的识别的结果实体对象

CarLicensePlateResult

OcrRect

矩形坐标

DriverLicenseCardResult

驾驶证识别的结果实体类

VehicleLicenseCardResult

行驶证识别的结果实体类

VehicleFrontInfo

行驶证的主页的识别结果实体类

VehicleBackInfo

行驶证副页的识别结果实体类

ISDKKitResultListener

文字识别 OCR 识别结果的回调类，用于接收识别结果以及错误异常。

/**
 * OCR 识别结果的回调类
 */
public interface ISDKKitResultListener {
    /**
     * orc 识别成功结果
     * @param response 识别结果 Json 信息
     * @param base64Str 所识别的图片 Base64 数据
     * @param requestId 此次识别请求的唯一标识符 requestId
     */
    void onProcessSucceed(String response, String base64Str, String requestId);

    /**
     * orc 识别异常
     * @param errorCode 错误码
     * @param message 异常信息
     * @param requestId 此次请求的唯一标识符 requestId
     */
    void onProcessFailed(String errorCode, String message, String requestId);
}

身份证正面请求返回 response 结果示例：

{
    "Name": "李明",
    "Sex": "男",
    "Nation": "汉",
    "Birth": "1987/1/1",
    "Address": "北京市石景山区高新技术园腾讯大楼",
    "IdNum": "440524******010014",
    "Authority": "",
    "ValidDate": "",
    "AdvancedInfo": "{}",
    "RequestId": "ab2c132e-9e1c-43d3-b0ef-9b4d80f00330"
 }

身份证反面请求返回 response 结果示例：

{
    "Name": "",
    "Sex": "",
    "Nation": "",
    "Birth": "",
    "Address": "",
    "IdNum": "",
    "Authority": "赵县公安局",
    "ValidDate": "2010.07.21-2020.07.21",
    "AdvancedInfo": "{}",
    "RequestId": "0d394478-6d4d-48fc-8b19-552415bf46de"
 }

银行卡请求返回 response 结果示例：

{
    "BankInfo": "招商银行(03080000)",
    "ValidDate": "07/2023",
    "CardType": "贷记卡",
    "CardName": "招商银行信用卡",
    "BorderCutImage": null,
    "CardNoImage": null,
    "WarningCode": [
      -9110
    ],
    "CardNo": "6225768888888888",
    "RequestId": "68f8fcbf-6004-0111a-ac18-6f1a9308fs100mab"
  }

名片请求结果返回 response 结果示例：

{
   "BusinessCardInfos": [
     {
       "Name": "姓名",
       "Value": "艾米"
     },
     {
       "Name": "职位",
       "Value": "视觉设计师"
     },
     {
       "Name": "部门",
       "Value": "社交平台部"
     },
     {
       "Name": "公司",
       "Value": "Tencent腾讯"
     },
     {
       "Name": "地址",
       "Value": "深圳市南山区高新技术园科技中一路腾讯大厦"
     },
     {
       "Name": "邮箱",
       "Value": "ab***fg@tencent.com"
     },
     {
       "Name": "手机",
       "Value": "+86-133****5678"
     },
     {
       "Name": "QQ",
       "Value": "1234567"
     },
     {
       "Name": "微信",
       "Value": "amy001"
     }
   ],
   "RetImageBase64": "",
   "RequestId": "98f8fcbf-933a-4e95-ac48-6f1a9308fs6h"
}

马来西亚身份证识别返回 response 结果示例：

 {
    "Name": "KAVIN ONG KHI MN",
    "ID": "710716-08-6085",
    "Address": "NO 11 PERSIARN PERAJRIT 4 TAMA PERAK 31400 IPOH ERAK",
    "Sex": "LEAKI",
    "Birthday": "",
    "Warn": [],
    "Image": "",
    "AdvancedInfo": "{\"ID\":{\"Confidence\":\"1.0000\"},\"Name\":{\"Confidence\":\"0.9996\"},\"Address\":{\"Confidence\":\"0.9997\"},\"Sex\":{\"Confidence\":\"0.9999\"}}",
    "Type": "MyKad",
    "RequestId": "c969da05-54e3-4d0a-a55d-b3ef90d4ebf5"
  }

车辆的 VIN 返回 response 结果示例：

{
  "Response": {
    "Vin": "LBV2B25G2E5069977",
    "RequestId": "c59d9002-6c8c-426d-b57f-a8837dee2c7c"
  }
}

车辆的车牌返回 response 结果示例：

{
  "Response": {
    "Number": "京N0L9U8",
    "Confidence": 99,
    "Rect": {
      "X": 217,
      "Y": 233,
      "Width": 170,
      "Height": 21
    },
    "RequestId": "210103d3-db06-4691-abe0-c0853aae606b"
  }
}

驾驶证识别的response结果示例：

{
    "Name": "李明",
    "Sex": "男",
    "Nationality": "中国",
    "Address": "上海市徐汇区田林路397号腾云大厦6F",
    "DateOfBirth": "1987-01-01",
    "IssuingAuthority": "上海市公安局交通警察总队",
    "DateOfFirstIssue": "2011-10-01",
    "Class": "C1",
    "StartDate": "2011-10-01",
    "EndDate": "2017-10-01",
    "CardCode": "440524198701010014",
    "ArchivesCode": "",
    "Record": "",
    "RecognizeWarnCode": [
      -9106
    ],
    "RecognizeWarnMsg": [
      "WARN_DRIVER_LICENSE_PS_CARD"
    ],
    "RequestId": "4ba2958b-e7cf-41c2-aafe-fdc985307f63"
  }

行驶证识别主页识别的response结果示例：

{
    "FrontInfo": {
      "PlateNo": "沪AA1234",
      "VehicleType": "小型轿车",
      "Owner": "李明",
      "Address": "上海市徐汇区田林路397号腾云大厦6F",
      "UseCharacter": "非营运",
      "Model": "别克牌SGM7151LAAA",
      "Vin": "ABCDEFGH123456789",
      "EngineNo": "8B54321",
      "RegisterDate": "2011-10-10",
      "IssueDate": "",
      "Seal": "上海市公安局交通警寨总队"
    },
    "BackInfo": null,
    "RecognizeWarnCode": [
      -9106
    ],
    "RecognizeWarnMsg": [
      "WARN_DRIVER_LICENSE_PS_CARD"
    ],
    "RequestId": "820916b4-b391-40a8-9203-7ae87e3f1954"
  }

行驶证识别副页识别的response结果示例：

{
    "FrontInfo": null,
    "BackInfo": {
      "PlateNo": "皖AC4L50",
      "FileNo": "A00-00476807",
      "AllowNum": "5人",
      "TotalMass": "1837kg",
      "CurbWeight": "1431kg",
      "LoadQuality": "--",
      "ExternalSize": "4620×1780×1498mm",
      "TotalQuasiMass": "--",
      "Marks": "",
      "Record": "检验有效期至2015年11月皖A(4S)"
    },
    "RecognizeWarnCode": [
      -9106
    ],
    "RecognizeWarnMsg": [
      "WARN_DRIVER_LICENSE_PS_CARD"
    ],
    "RequestId": "e2ebfaa0-19d3-4d2b-9ed8-7c7c21eb2b74"
  }

对于返回的错误码以及错误信息，可以参考 错误码 。

ISdkOcrEntityResultListener

文字识别 OCR 识别结果的回调类，用于接收识别结果的实体类以及错误异常。

public interface ISdkOcrEntityResultListener<T> {

    /**
     * orc 识别成功结果
     *
     * @param t 返回实体信息
     * @param base64Str 所识别的图片 Base64 数据
     */
    void onProcessSucceed(T t, String base64Str);

    /**
     * orc 识别异常
     *
     * @param errorCode 错误码
     * @param message 异常信息
     * @param requestId 此次请求的唯一标识符 requestId
     */
    void onProcessFailed(String errorCode, String message, String requestId);
}

错误码

公共错误码

业务错误码

SDK 本地错误码