Skip to content

Repository contains PHP Library for communicating with the Aspose.BarCode Cloud API

License

Notifications You must be signed in to change notification settings

aspose-barcode-cloud/aspose-barcode-cloud-php

Repository files navigation

Aspose.BarCode Cloud SDK for PHP

License Test Packagist Version Supported PHP Versions

  • API version: 4.0
  • Package version: 25.1.0
  • Supported PHP versions: ">=7.4 || >=8.0"

SDK and API Version Compatibility:

  • SDK Version 25.1 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
  • SDK Version 24.12 and Earlier: These versions are compatible with API Version v3.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 PHP source code.

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

You can either directly use it in your project via source code or get Packagist distribution (recommended).

Installation

Via Composer

barcode-cloud-php is available on Packagist as the barcode-cloud-php package. Run the following command:

composer require aspose/barcode-cloud-php

To use the SDK, use Composer's autoload:

require __DIR__ . '/vendor/autoload.php';

Sample usage

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

use Aspose\BarCode\Configuration;
use Aspose\BarCode\GenerateApi;
use Aspose\BarCode\Requests\GenerateRequestWrapper;
use Aspose\BarCode\Model\{EncodeBarcodeType, EncodeDataType, CodeLocation, BarcodeImageFormat};

$config = new Configuration();
$config->setClientId('ClientId from https://dashboard.aspose.cloud/applications');
$config->setClientSecret('Client Secret from https://dashboard.aspose.cloud/applications');
if (getenv("TEST_CONFIGURATION_ACCESS_TOKEN")) {
    $config->setAccessToken(getenv("TEST_CONFIGURATION_ACCESS_TOKEN"));
}

$request = new GenerateRequestWrapper(EncodeBarcodeType::QR, 'PHP SDK Test');
$request->image_format = BarcodeImageFormat::Png;
$request->text_location = CodeLocation::None;

$api = new GenerateApi(null, $config);
$response = $api->generate($request);

$type = 'image/png';
$size = $response->getSize();
header("Content-Type: $type");
header("Content-Length: $size");
echo $response->fread($size);

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/v4.0

Class Method HTTP request Description
GenerateApi generate GET /barcode/generate/{barcodeType} Generate barcode using GET request with parameters in route and query string.
GenerateApi generateBody POST /barcode/generate-body Generate barcode using POST request with parameters in body in json or xml format.
GenerateApi generateMultipart POST /barcode/generate-multipart Generate barcode using POST request with parameters in multipart form.
RecognizeApi recognize GET /barcode/recognize Recognize barcode from file on server using GET requests with parameters in route and query string.
RecognizeApi recognizeBase64 POST /barcode/recognize-body Recognize barcode from file in request body using POST requests with parameters in body in json or xml format.
RecognizeApi recognizeMultipart POST /barcode/recognize-multipart Recognize barcode from file in request body using POST requests with parameters in multipart form.
ScanApi scan GET /barcode/scan Scan barcode from file on server using GET requests with parameter in query string.
ScanApi scanBase64 POST /barcode/scan-body Scan barcode from file in request body using POST requests with parameter in body in json or xml format.
ScanApi scanMultipart POST /barcode/scan-multipart Scan barcode from file in request body using POST requests with parameter in multipart form.

Documentation For Models