Aspose.Barcode for Cloud is a REST API for barcode generation and recognition. It helps you generate barcode images from scratch in linear (1D), two dimensional (2D), and postal formats. Generate barcode images in a variety of image formats: JPEG, PNG, GIF, BMP, TIFF and SVG. Recognize barcodes from different image types.
Aspose.Barcode for Cloud allows you to control all aspects of the image and barcode when generating barcode images. Specify image width, height, border style, output image format and more. You can also set barcode attributes like font style, font color, background color, barcode type and the barcode text location.
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 .NET source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your .NET Core or .NET Framework applications quickly and easily.
Aspose.BarCode Cloud SDK for .NET provides cross-platform bindings for:
.NET 5 and higher
.NET Standard 2.0 and higher
.NET Core 3.1 and higher
.NET Framework 4.6.2 and higher
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).
How to use the SDK?
The complete source code is available in this repository folder. You can either directly use it in your project via source code or get NuGet distribution (recommended).
Prerequisites
To use Aspose.BarCode Cloud SDK for .NET you need to register an account with Aspose Cloud and lookup/create Client Secret and Client Id at Cloud Dashboard. There is free quota available. For more details, see Aspose Cloud Pricing.
Installation
Install Aspose.BarCode-Cloud via NuGet
From the command line:
nuget install Aspose.BarCode-Cloud
From Package Manager:
PM> Install-Package Aspose.BarCode-Cloud
From within Visual Studio:
Open the Solution Explorer.
Right-click on a project within your solution.
Click on Manage NuGet Packages...
Click on the Browse tab and search for "Aspose.BarCode-Cloud".
Click on the Aspose.BarCode-Cloud package, select the appropriate version in the right-tab and click Install.
Recognize QR code
The examples below show how you can recognize QR code from image:
using Aspose.BarCode.Cloud.Sdk.Api;
using Aspose.BarCode.Cloud.Sdk.Interfaces;
using Aspose.BarCode.Cloud.Sdk.Model;
using Aspose.BarCode.Cloud.Sdk.Model.Requests;
using System;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;
namespace ReadQR;
internal static class Program
{
private static Configuration MakeConfiguration()
{
Configuration config = new Configuration();
string? envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_JWT_TOKEN");
if (string.IsNullOrEmpty(envToken))
{
config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
}
else
{
config.JwtToken = envToken;
}
return config;
}
private static async Task<string> ReadQR(IBarcodeApi api, string fileName)
{
await using (FileStream imageStream = File.OpenRead(fileName))
{
BarcodeResponseList recognized = await api.PostBarcodeRecognizeFromUrlOrContentAsync(
new PostBarcodeRecognizeFromUrlOrContentRequest(image: imageStream)
{
Type = DecodeBarcodeType.QR.ToString(),
Preset = PresetType.HighPerformance.ToString(),
}
);
return recognized.Barcodes[0].BarcodeValue;
}
}
public static async Task Main(string[] args)
{
string fileName = Path.GetFullPath(Path.Join(
Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location),
"..", "..", "..", "..",
"qr.png"
));
BarcodeApi api = new BarcodeApi(MakeConfiguration());
string result = await ReadQR(api, fileName);
Console.WriteLine($"File '{fileName}' recognized, result: '{result}'");
}
}
Generate QR code
The examples below show how you can generate QR code and save it into local file using Aspose.BarCode-Cloud library:
using Aspose.BarCode.Cloud.Sdk.Api;
using Aspose.BarCode.Cloud.Sdk.Interfaces;
using Aspose.BarCode.Cloud.Sdk.Model;
using Aspose.BarCode.Cloud.Sdk.Model.Requests;
using System;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;
namespace GenerateQR;
internal static class Program
{
private static Configuration MakeConfiguration()
{
Configuration config = new Configuration();
string? envToken = Environment.GetEnvironmentVariable("TEST_CONFIGURATION_JWT_TOKEN");
if (string.IsNullOrEmpty(envToken))
{
config.ClientId = "Client Id from https://dashboard.aspose.cloud/applications";
config.ClientSecret = "Client Secret from https://dashboard.aspose.cloud/applications";
}
else
{
config.JwtToken = envToken;
}
return config;
}
private static async Task GenerateQR(IBarcodeApi api, string fileName)
{
await using (Stream generated = await api.GetBarcodeGenerateAsync(
new GetBarcodeGenerateRequest(
EncodeBarcodeType.QR.ToString(),
"QR code text")
{
TextLocation = "None",
format = "png"
})
)
{
await using (FileStream stream = File.Create(fileName))
{
await generated.CopyToAsync(stream);
}
}
}
public static async Task Main(string[] args)
{
string fileName = Path.GetFullPath(Path.Join(
Path.GetDirectoryName(Assembly.GetEntryAssembly()!.Location),
"..", "..", "..", "..",
"qr.png"
));
BarcodeApi api = new BarcodeApi(MakeConfiguration());
await GenerateQR(api, fileName);
Console.WriteLine($"File '{fileName}' generated.");
}
}
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.
