Aspose.BarCode Cloud SDK for Dart
- API version: 3.0
- SDK version: 1.24.10
This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Dart or Flutter applications quickly and easily
Demo applications
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 Dart source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Dart or Flutter applications quickly and easily.
To use these SDKs, you will need Client Id and Client Secret which can be looked up at Aspose Cloud Dashboard (free registration in Aspose Cloud is required for this).
Prerequisites
To use Aspose.BarCode Cloud SDK for Dart you need to register an account with Aspose Cloud and lookup/create Client Secret and SID at Cloud Dashboard. There is a free quota available. For more details, see Aspose Cloud Pricing.
Requirements
Dart 2.12.0 or later
Installation & Usage
Add this dependency to your pubspec.yaml:
dependencies:
aspose_barcode_cloud: 1.24.10
Sample usage
Generate an image with barcode and then recognize it
The examples below show how you can generate QR barcode and save it into a local file and then recognize using aspose_barcode_cloud:
import 'dart:io';
import 'dart:typed_data';
import 'package:aspose_barcode_cloud/aspose_barcode_cloud.dart';
import 'package:http/http.dart' show MultipartFile;
Future<void> main() async {
const fileName = "qr.png";
final api = BarcodeApi(ApiClient(Configuration(
clientId: "Client Id from https://dashboard.aspose.cloud/applications",
clientSecret:
"Client Secret from https://dashboard.aspose.cloud/applications",
// For testing only
accessToken: Platform.environment["TEST_CONFIGURATION_ACCESS_TOKEN"],
)));
// Generate image with barcode
final Uint8List generated = await api.getBarcodeGenerate(
EncodeBarcodeType.QR.toString(),
"text",
textLocation: CodeLocation.None.toString(),
);
// Save generated image to file
File(fileName).writeAsBytesSync(generated);
print("Generated image saved to '$fileName'");
// Recognize generated image
final formFile = MultipartFile.fromBytes("image", generated.toList(),
filename: "barcode.png");
final BarcodeResponseList recognized = await api.scanBarcode(
formFile,
decodeTypes: [DecodeBarcodeType.QR],
);
if (recognized.barcodes != null && recognized.barcodes!.isNotEmpty) {
print("Recognized Type: ${recognized.barcodes![0].type!}");
print("Recognized Value: ${recognized.barcodes![0].barcodeValue!}");
} else {
print("No barcode found");
}
}
Dependencies
- http: '>=0.13.0 <2.0.0'
Licensing
All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed under MIT License.
Resources
Documentation for API Endpoints
All URIs are relative to 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 |
Documentation For Models
- 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