Aspose.BarCode-Cloud 22.9.0

.NET Standard 2.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package Aspose.BarCode-Cloud --version 22.9.0
NuGet\Install-Package Aspose.BarCode-Cloud -Version 22.9.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Aspose.BarCode-Cloud" Version="22.9.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aspose.BarCode-Cloud --version 22.9.0
#r "nuget: Aspose.BarCode-Cloud, 22.9.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Aspose.BarCode-Cloud as a Cake Addin
#addin nuget:?package=Aspose.BarCode-Cloud&version=22.9.0

// Install Aspose.BarCode-Cloud as a Cake Tool
#tool nuget:?package=Aspose.BarCode-Cloud&version=22.9.0

Aspose.BarCode Cloud SDK for .NET

License .NET Core .NET 6 .NET Framework Nuget

  • API version: 3.0
  • SDK version: 22.9.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 .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 2.1 and higher
  • .NET Framework 4.6.1 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:

  1. Open the Solution Explorer.
  2. Right-click on a project within your solution.
  3. Click on Manage NuGet Packages...
  4. Click on the Browse tab and search for "Aspose.BarCode-Cloud".
  5. 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;

namespace ReadQR
{
    class Program
    {
        static Configuration MakeConfiguration()
        {
            var config = new Configuration();

            var 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;
        }

        static string ReadQR(IBarcodeApi api, string fileName)
        {
            using (FileStream imageStream = File.OpenRead(fileName))
            {
                BarcodeResponseList recognized = api.PostBarcodeRecognizeFromUrlOrContent(
                    new PostBarcodeRecognizeFromUrlOrContentRequest(image: imageStream)
                );

                return recognized.Barcodes[0].BarcodeValue;
            }
        }

        static void Main(string[] args)
        {
            string fileName = Path.GetFullPath(Path.Join(
                Path.GetDirectoryName(Assembly.GetEntryAssembly().Location),
                "..", "..", "..", "..",
                "qr.png"
                ));

            var api = new BarcodeApi(MakeConfiguration());

            string result = 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;

namespace GenerateQR
{
    class Program
    {
        static Configuration MakeConfiguration()
        {
            var config = new Configuration();

            var 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;
        }

        static void GenerateQR(IBarcodeApi api, string fileName)
        {
            using (Stream generated = api.GetBarcodeGenerate(
                new GetBarcodeGenerateRequest(
                    EncodeBarcodeType.QR.ToString(),
                    "QR code text",
                    textLocation: "None", format: "png"))
            )
            {
                using (FileStream stream = File.Create(fileName))
                {
                    generated.CopyTo(stream);
                }
            }
        }

        static void Main(string[] args)
        {
            string fileName = Path.GetFullPath(Path.Join(
                Path.GetDirectoryName(Assembly.GetEntryAssembly().Location),
                "..", "..", "..", "..",
                "qr.png"
                ));

            var api = new BarcodeApi(MakeConfiguration());

            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 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

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

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
22.11.0 55 11/24/2022
22.10.0 113 10/28/2022
22.9.0 217 9/16/2022
22.8.0 166 8/25/2022
22.7.0 185 7/27/2022
22.3.0 333 3/31/2022
22.1.1 234 1/31/2022
22.1.0 277 1/14/2022
21.12.0 297 12/10/2021
21.10.0 220 10/13/2021
21.9.0 229 9/23/2021
21.7.0 365 7/22/2021
21.6.0 312 6/29/2021
21.3.0 433 3/11/2021
21.2.0 355 2/9/2021
20.12.0 475 12/25/2020
20.11.0 450 11/10/2020
20.10.0 408 10/28/2020
20.8.0 459 8/3/2020
20.6.1 479 6/26/2020
20.6.0 498 6/9/2020
20.5.1 576 5/22/2020
19.10.1 493 4/16/2020
19.10.0 602 10/21/2019
18.6.0 817 7/23/2018
1.1.0 968 2/4/2018
1.0.8 837 9/27/2017
1.0.7 803 9/27/2017
1.0.6 842 8/14/2017
1.0.5 885 5/26/2017
1.0.4 1,120 1/6/2017
1.0.3 997 11/2/2016
1.0.2 873 10/21/2016
1.0.1 1,439 2/26/2016
1.0.0 1,514 2/26/2016