aspose-barcode-cloud 24.10.0

Aspose.Barcode Cloud API Reference

Aspose.BarCode Cloud SDK for Python

• API version: 3.0
• Package version: 24.10.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 Python source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Python 3 applications quickly and easily.

Supported Python versions:

• Python 3.6+

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 from PyPi (recommended).

Prerequisites

To use Aspose.BarCode Cloud SDK for Python 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 pip

From the command line:

pip install aspose-barcode-cloud

Then import the package:

import aspose_barcode_cloud

Sample usage

The examples below show how you can generate and recognize Code128 barcode and save it into local file using aspose-barcode-cloud:

import os
from pprint import pprint

from aspose_barcode_cloud import (
    BarcodeApi,
    ApiClient,
    Configuration,
    EncodeBarcodeType,
    CodeLocation,
    DecodeBarcodeType,
)

config = Configuration(
    client_id="Client Id from https://dashboard.aspose.cloud/applications",
    client_secret="Client Secret from https://dashboard.aspose.cloud/applications",
    access_token=os.environ.get("TEST_CONFIGURATION_ACCESS_TOKEN"),  # Only for testing in CI, remove this line
)

api = BarcodeApi(ApiClient(config))

# Generate barcode
response = api.get_barcode_generate(EncodeBarcodeType.QR, "Example", text_location=CodeLocation.NONE)
with open("example.png", "wb") as f:
    f.write(response.data)
print("Barcode saved to file 'example.png'")

# Recognize barcode
response = api.scan_barcode("example.png", decode_types=[DecodeBarcodeType.QR])
pprint(response)

Requirements

• urllib3 >= 1.21.1, <2.0

Licensing

All Aspose.BarCode for Cloud SDKs, helper scripts and templates are licensed under MIT License.

Resources

• Website
• Product Home
• Documentation
• Free Support Forum
• Paid Support Helpdesk
• Blog

Documentation for API Endpoints

All URIs are relative to https://api.aspose.cloud/v3.0

Class	Method	HTTP request	Description
BarcodeApi	get_barcode_generate	GET /barcode/generate	Generate barcode.
BarcodeApi	get_barcode_recognize	GET /barcode/{name}/recognize	Recognize barcode from a file on server.
BarcodeApi	post_barcode_recognize_from_url_or_content	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	post_generate_multiple	POST /barcode/generateMultiple	Generate multiple barcodes and return in response stream
BarcodeApi	put_barcode_generate_file	PUT /barcode/{name}/generate	Generate barcode and save on server (from query params or from file with json or xml content)
BarcodeApi	put_barcode_recognize_from_body	PUT /barcode/{name}/recognize	Recognition of a barcode from file on server with parameters in body.
BarcodeApi	put_generate_multiple	PUT /barcode/{name}/generateMultiple	Generate image with multiple barcodes and put new file on server
BarcodeApi	scan_barcode	POST /barcode/scan	Quickly scan a barcode from an image.
FileApi	copy_file	PUT /barcode/storage/file/copy/{srcPath}	Copy file
FileApi	delete_file	DELETE /barcode/storage/file/{path}	Delete file
FileApi	download_file	GET /barcode/storage/file/{path}	Download file
FileApi	move_file	PUT /barcode/storage/file/move/{srcPath}	Move file
FileApi	upload_file	PUT /barcode/storage/file/{path}	Upload file
FolderApi	copy_folder	PUT /barcode/storage/folder/copy/{srcPath}	Copy folder
FolderApi	create_folder	PUT /barcode/storage/folder/{path}	Create the folder
FolderApi	delete_folder	DELETE /barcode/storage/folder/{path}	Delete folder
FolderApi	get_files_list	GET /barcode/storage/folder/{path}	Get all files and folders within a folder
FolderApi	move_folder	PUT /barcode/storage/folder/move/{srcPath}	Move folder
StorageApi	get_disc_usage	GET /barcode/storage/disc	Get disc usage
StorageApi	get_file_versions	GET /barcode/storage/version/{path}	Get file versions
StorageApi	object_exists	GET /barcode/storage/exist/{path}	Check if file or folder exists
StorageApi	storage_exists	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