Help Center> Optical Character Recognition> SDK Reference> Using Java SDK
View PDF

Using Java SDK

Users can use SDK in token- or AK/SK-based authentication mode. For details about how to obtain authentication messages, see Authentication. This section describes how to use SDK in token- and AK/SK-based modes.

Download OCR Java SDK from https://developer.huaweicloud.com/en-us/sdk?OCR, and decompress it.

  • All images in this document are composite images and used for reference only.
  • A user needs to apply for enabling the service before using it for the first time. For details about how to enable the service, click Subscribe. You only need to subscribe to OCR once.

AK/SK-based Authentication

This section uses ID Card OCR as an example to describe how to use SDK in AK/SK-based authentication mode.

  1. Obtain AK/SK. For details, see Authentication > AK/SK-based Authentication.
  2. Configure AK/SK of the Java SDK.

    Change the values of AK and SK of the AKSKDemo function in the OCRDemo.java file of the demo project to the obtained AK/SK.

    Figure 1 Modifying parameters in the OCRDemo.java file
  3. Modify parameters.

    If you use a local image file for recognition, change the image path in OCRDemo.java to the path of the file. If you use the default image of the SDK, you do not need to modify the image path.

  4. Execute the OCRDemo.java file. If 200 is displayed on the console, the program is successfully executed. You can view the recognition result of ID Card OCR on the console. 
    {
    "result": {
        "name": "xx", 
        "sex": "sex recognized from the image",
        "ethnicity": "ethnicity recognized from the image",
        "birth": "1990-xx-xx", 
        "address": "address recognized from the image",
        "number": "3892011990012xxxxx"
    }
}

    To call other OCR services, change the value of parameter httpUri of the AKSKDemo function to the specific URI. For the URI list, see Mappings Between Services and APIs.

Token-based Authentication

This section uses ID Card OCR as an example to describe how to use SDK in token-based authentication mode.

  1. Open the OCRDemo.java file in the OCRDemo package. Change the values of username, password, and domainName in the TokenDemo function to the actual username, password, and domain name registered with the system. If the user is not an IAM user, the domain name and username are the same.
    Figure 2 Changing the username, password, and domain name in the OCRDemo.java file
  2. Execute the code. The recognition result of ID Card OCR is displayed.

Status Code

For details about status code, see Status Code.

Error Code

For details about error code, see Error Code.