- API version: 3.0
- SDK version: 24.7.0
Scan QR | Generate Barcode | Recognize Barcode |
---|---|---|
Generate Wi-Fi QR | Embed Barcode | Scan Barcode |
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:
- Java 8 (JDK 1.8)
- 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.
Add Aspose Cloud repository to your application pom.xml
<repository>
<id>aspose-cloud</id>
<name>Aspose Cloud Repository</name>
<url>https://releases.aspose.cloud/java/repo/</url>
</repository>
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.
Add this dependency to your project's POM:
<dependency>
<groupId>com.aspose</groupId>
<artifactId>aspose-barcode-cloud</artifactId>
<version>24.7.0</version>
<scope>compile</scope>
</dependency>
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/aspose-barcode-cloud-24.7.0.jar
target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
package com.aspose.barcode.cloud.examples;
import com.aspose.barcode.cloud.ApiClient;
import com.aspose.barcode.cloud.ApiException;
import com.aspose.barcode.cloud.api.BarcodeApi;
import com.aspose.barcode.cloud.model.BarcodeResponseList;
import com.aspose.barcode.cloud.model.DecodeBarcodeType;
import com.aspose.barcode.cloud.model.EncodeBarcodeType;
import com.aspose.barcode.cloud.requests.GetBarcodeGenerateRequest;
import com.aspose.barcode.cloud.requests.ScanBarcodeRequest;
import java.io.File;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient client =
new ApiClient(
"Client Id from https://dashboard.aspose.cloud/applications",
"Client Secret from https://dashboard.aspose.cloud/applications");
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 = scanBarcode(api, barcodeImage);
System.out.print("Barcode on image:");
System.out.println(recognized.toString());
} catch (ApiException e) {
System.err.println("Error");
e.printStackTrace();
}
}
private static File generateBarcode(BarcodeApi api) throws ApiException {
String type = EncodeBarcodeType.QR.toString();
String text = "Aspose.BarCode for Cloud Sample";
GetBarcodeGenerateRequest request = new GetBarcodeGenerateRequest(type, text);
request.textLocation = "None";
return api.getBarcodeGenerate(request);
}
private static BarcodeResponseList scanBarcode(BarcodeApi api, File barcodeImage)
throws ApiException {
ScanBarcodeRequest request = new ScanBarcodeRequest(barcodeImage);
request.decodeTypes = Collections.singletonList(DecodeBarcodeType.QR);
return api.scanBarcode(request);
}
}
All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed under MIT License.
All URIs are relative to https://api.aspose.cloud/v3.0
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 with content-type "application/octet-stream". An image can also be passed as a form field. |
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 |
BarcodeApi | scanBarcode | POST /barcode/scan | Quickly scan a barcode from an image. |
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 |
- ApiError
- ApiErrorResponse
- AustralianPostParams
- AutoSizeMode
- AvailableGraphicsUnit
- AztecEncodeMode
- AztecParams
- AztecSymbolMode
- BarcodeResponse
- BarcodeResponseList
- BorderDashStyle
- CaptionParams
- ChecksumValidation
- CodabarChecksumMode
- CodabarParams
- CodabarSymbol
- CodablockParams
- Code128Emulation
- Code128EncodeMode
- Code128Params
- Code16KParams
- CodeLocation
- CouponParams
- CustomerInformationInterpretingType
- DataBarParams
- DataMatrixEccType
- DataMatrixEncodeMode
- DataMatrixParams
- DataMatrixVersion
- DecodeBarcodeType
- DiscUsage
- DotCodeEncodeMode
- DotCodeParams
- ECIEncodings
- EnableChecksum
- EncodeBarcodeType
- Error
- ErrorDetails
- FileVersions
- FilesList
- FilesUploadResult
- FontMode
- FontParams
- FontStyle
- GeneratorParams
- GeneratorParamsList
- HanXinEncodeMode
- HanXinErrorLevel
- HanXinParams
- HanXinVersion
- ITF14BorderType
- ITFParams
- MacroCharacter
- MaxiCodeEncodeMode
- MaxiCodeMode
- MaxiCodeParams
- ObjectExist
- Padding
- PatchCodeParams
- PatchFormat
- Pdf417CompactionMode
- Pdf417ErrorLevel
- Pdf417MacroTerminator
- Pdf417Params
- PostalParams
- PresetType
- QREncodeMode
- QREncodeType
- QRErrorLevel
- QRVersion
- QrParams
- ReaderParams
- RegionPoint
- ResultImageInfo
- StorageExist
- StorageFile
- StructuredAppend
- TextAlignment
- FileVersion
Authentication schemes defined for the API:
- Type: OAuth
- Flow: application
- Authorization URL: https://api.aspose.cloud/connect/token
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.