Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Aspose.BarCode Cloud SDK for Java

License Java CI with Maven Maven metadata URL

  • API version: 3.0
  • SDK version: 23.1.0

Demo applications

Scan QR Generate Barcode Recognize Barcode
ScanQR Generate Recognize
Generate Wi-Fi QR Embed Barcode Scan Barcode
Wi-FiQR Embed Scan

Aspose.BarCode for Cloud is a REST API for Linear, 2D and postal barcode generation and recognition in the cloud. API recognizes and generates barcode images in a variety of formats. Barcode REST API allows to specify barcode image attributes like image width, height, border style and output image format in order to customize the generation process. Developers can also specify the barcode type and text attributes such as text location and font styles in order to suit the application requirements.

This repository contains Aspose.BarCode Cloud SDK for Java source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Java applications quickly and easily.


Building the API client library requires:

  1. Java 1.7+
  2. Maven


To use Aspose.BarCode Cloud SDK for Java you need to register an account with Aspose Cloud and lookup/create Client Id and Client Secret at Cloud Dashboard. There is free quota available. For more details, see Aspose Cloud Pricing.


Install Aspose.BarCode-Cloud from Maven

Add Aspose Cloud repository to your application pom.xml

    <name>Aspose Cloud Repository</name>

Install from source

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:



At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/aspose-barcode-cloud-23.1.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:



public class BarcodeApiExample {
    public static void main(String[] args) {
        ApiClient client = new ApiClient(
            "Client Id from",
            "Client Secret from"
        client.setReadTimeout(5 * 60 * 1000);

        BarcodeApi api = new BarcodeApi(client);

        try {
            System.out.println("Generating barcode...");
            File barcodeImage = generateBarcode(api);
            System.out.println("Barcode image saved to file " + barcodeImage.getAbsolutePath());

            System.out.println("Recognizing barcode on image...");
            BarcodeResponseList recognized = recognizeBarcode(api, barcodeImage);
            System.out.print("Barcode on image:");
        } catch (ApiException e) {

    private static File generateBarcode(BarcodeApi api) throws ApiException {
        String type = EncodeBarcodeType.PDF417.toString();
        String text = "Aspose.BarCode for Cloud Sample";
        GetBarcodeGenerateRequest request = new GetBarcodeGenerateRequest(type, text);

        return api.getBarcodeGenerate(request);

    private static BarcodeResponseList recognizeBarcode(BarcodeApi api, File barcodeImage) throws ApiException {
        PostBarcodeRecognizeFromUrlOrContentRequest recognizeRequest = new PostBarcodeRecognizeFromUrlOrContentRequest();
        recognizeRequest.image = barcodeImage;
        recognizeRequest.preset = PresetType.HIGHPERFORMANCE.toString();

        return api.postBarcodeRecognizeFromUrlOrContent(recognizeRequest);


All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed under MIT License.


Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
BarcodeApi getBarcodeGenerate GET /barcode/generate Generate barcode.
BarcodeApi getBarcodeRecognize GET /barcode/{name}/recognize Recognize barcode from a file on server.
BarcodeApi postBarcodeRecognizeFromUrlOrContent POST /barcode/recognize Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
BarcodeApi postGenerateMultiple POST /barcode/generateMultiple Generate multiple barcodes and return in response stream
BarcodeApi putBarcodeGenerateFile PUT /barcode/{name}/generate Generate barcode and save on server (from query params or from file with json or xml content)
BarcodeApi putBarcodeRecognizeFromBody PUT /barcode/{name}/recognize Recognition of a barcode from file on server with parameters in body.
BarcodeApi putGenerateMultiple PUT /barcode/{name}/generateMultiple Generate image with multiple barcodes and put new file on server
FileApi copyFile PUT /barcode/storage/file/copy/{srcPath} Copy file
FileApi deleteFile DELETE /barcode/storage/file/{path} Delete file
FileApi downloadFile GET /barcode/storage/file/{path} Download file
FileApi moveFile PUT /barcode/storage/file/move/{srcPath} Move file
FileApi uploadFile PUT /barcode/storage/file/{path} Upload file
FolderApi copyFolder PUT /barcode/storage/folder/copy/{srcPath} Copy folder
FolderApi createFolder PUT /barcode/storage/folder/{path} Create the folder
FolderApi deleteFolder DELETE /barcode/storage/folder/{path} Delete folder
FolderApi getFilesList GET /barcode/storage/folder/{path} Get all files and folders within a folder
FolderApi moveFolder PUT /barcode/storage/folder/move/{srcPath} Move folder
StorageApi getDiscUsage GET /barcode/storage/disc Get disc usage
StorageApi getFileVersions GET /barcode/storage/version/{path} Get file versions
StorageApi objectExists GET /barcode/storage/exist/{path} Check if file or folder exists
StorageApi storageExists GET /barcode/storage/{storageName}/exist Check if storage exists

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:



It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.