Aspose.BarCode-Cloud
24.12.0
dotnet add package Aspose.BarCode-Cloud --version 24.12.0
NuGet\Install-Package Aspose.BarCode-Cloud -Version 24.12.0
<PackageReference Include="Aspose.BarCode-Cloud" Version="24.12.0" />
paket add Aspose.BarCode-Cloud --version 24.12.0
#r "nuget: Aspose.BarCode-Cloud, 24.12.0"
// Install Aspose.BarCode-Cloud as a Cake Addin #addin nuget:?package=Aspose.BarCode-Cloud&version=24.12.0 // Install Aspose.BarCode-Cloud as a Cake Tool #tool nuget:?package=Aspose.BarCode-Cloud&version=24.12.0
Aspose.BarCode Cloud SDK for .NET
- API version: 3.0
- SDK version: 24.12.0
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 .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.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Threading.Tasks;
namespace ReadQR;
internal static class Program
{
private static Configuration MakeConfiguration()
{
var 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.ScanBarcodeAsync(
new ScanBarcodeRequest(imageStream)
{
decodeTypes = new List<DecodeBarcodeType> { DecodeBarcodeType.QR }
}
);
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"
));
var 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()
{
var 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 = CodeLocation.None.ToString(),
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.");
}
}
Dependencies
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 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 |
Documentation for Models
- Model.ApiError
- Model.ApiErrorResponse
- Model.AustralianPostParams
- Model.AutoSizeMode
- Model.AvailableGraphicsUnit
- Model.AztecEncodeMode
- Model.AztecParams
- Model.AztecSymbolMode
- Model.BarcodeResponse
- Model.BarcodeResponseList
- Model.BorderDashStyle
- Model.CaptionParams
- Model.ChecksumValidation
- Model.CodabarChecksumMode
- Model.CodabarParams
- Model.CodabarSymbol
- Model.CodablockParams
- Model.Code128Emulation
- Model.Code128EncodeMode
- Model.Code128Params
- Model.Code16KParams
- Model.CodeLocation
- Model.CouponParams
- Model.CustomerInformationInterpretingType
- Model.DataBarParams
- Model.DataMatrixEccType
- Model.DataMatrixEncodeMode
- Model.DataMatrixParams
- Model.DataMatrixVersion
- Model.DecodeBarcodeType
- Model.DiscUsage
- Model.DotCodeEncodeMode
- Model.DotCodeParams
- Model.ECIEncodings
- Model.EnableChecksum
- Model.EncodeBarcodeType
- Model.Error
- Model.ErrorDetails
- Model.FileVersions
- Model.FilesList
- Model.FilesUploadResult
- Model.FontMode
- Model.FontParams
- Model.FontStyle
- Model.GeneratorParams
- Model.GeneratorParamsList
- Model.HanXinEncodeMode
- Model.HanXinErrorLevel
- Model.HanXinParams
- Model.HanXinVersion
- Model.ITF14BorderType
- Model.ITFParams
- Model.MacroCharacter
- Model.MaxiCodeEncodeMode
- Model.MaxiCodeMode
- Model.MaxiCodeParams
- Model.ObjectExist
- Model.Padding
- Model.PatchCodeParams
- Model.PatchFormat
- Model.Pdf417CompactionMode
- Model.Pdf417ErrorLevel
- Model.Pdf417MacroTerminator
- Model.Pdf417Params
- Model.PostalParams
- Model.PresetType
- Model.QREncodeMode
- Model.QREncodeType
- Model.QRErrorLevel
- Model.QRVersion
- Model.QrParams
- Model.ReaderParams
- Model.RegionPoint
- Model.ResultImageInfo
- Model.StorageExist
- Model.StorageFile
- Model.StructuredAppend
- Model.TextAlignment
- Model.FileVersion
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
24.12.0 | 27 | 12/24/2024 | |
24.11.0 | 101 | 11/29/2024 | |
24.10.0 | 103 | 10/25/2024 | |
24.9.0 | 117 | 9/27/2024 | |
24.8.0 | 104 | 8/27/2024 | |
24.7.0 | 93 | 7/26/2024 | |
24.6.0 | 133 | 6/27/2024 | |
24.5.0 | 118 | 5/28/2024 | |
24.4.0 | 131 | 4/29/2024 | |
24.3.0 | 122 | 3/25/2024 | |
24.2.0 | 114 | 2/29/2024 | |
24.1.0 | 546 | 1/30/2024 | |
23.12.0 | 322 | 12/27/2023 | |
23.11.0 | 161 | 11/28/2023 | |
23.10.0 | 172 | 10/27/2023 | |
23.9.0 | 167 | 9/22/2023 | |
23.8.0 | 173 | 8/30/2023 | |
23.7.0 | 484 | 7/14/2023 | |
23.6.0 | 170 | 6/29/2023 | |
23.5.0 | 155 | 5/19/2023 | |
23.4.0 | 192 | 4/27/2023 | |
23.3.0 | 227 | 3/28/2023 | |
23.2.0 | 255 | 2/28/2023 | |
23.1.0 | 305 | 1/31/2023 | |
22.12.0 | 348 | 12/19/2022 | |
22.11.0 | 363 | 11/24/2022 | |
22.10.0 | 412 | 10/28/2022 | |
22.9.0 | 693 | 9/16/2022 | |
22.8.0 | 439 | 8/25/2022 | |
22.7.0 | 460 | 7/27/2022 | |
22.3.0 | 601 | 3/31/2022 | |
22.1.1 | 499 | 1/31/2022 | |
22.1.0 | 565 | 1/14/2022 | |
21.12.0 | 454 | 12/10/2021 | |
21.10.0 | 370 | 10/13/2021 | |
21.9.0 | 373 | 9/23/2021 | |
21.7.0 | 522 | 7/22/2021 | |
21.6.0 | 450 | 6/29/2021 | |
21.3.0 | 572 | 3/11/2021 | |
21.2.0 | 498 | 2/9/2021 | |
20.12.0 | 632 | 12/25/2020 | |
20.11.0 | 603 | 11/10/2020 | |
20.10.0 | 563 | 10/28/2020 | |
20.8.0 | 611 | 8/3/2020 | |
20.6.1 | 639 | 6/26/2020 | |
20.6.0 | 644 | 6/9/2020 | |
20.5.1 | 726 | 5/22/2020 | |
19.10.1 | 663 | 4/16/2020 | |
19.10.0 | 758 | 10/21/2019 | |
18.6.0 | 1,021 | 7/23/2018 | |
1.1.0 | 1,170 | 2/4/2018 | |
1.0.8 | 1,009 | 9/27/2017 | |
1.0.7 | 960 | 9/27/2017 | |
1.0.6 | 998 | 8/14/2017 | |
1.0.5 | 1,048 | 5/26/2017 | |
1.0.4 | 1,305 | 1/6/2017 | |
1.0.3 | 1,165 | 11/2/2016 | |
1.0.2 | 1,034 | 10/21/2016 | |
1.0.1 | 1,637 | 2/26/2016 | |
1.0.0 | 1,724 | 2/26/2016 |