aspose-barcode-cloud-go

README

Aspose.BarCode Cloud SDK for Go

• API version: 4.0
• SDK version: 4.2501.0

SDK and API Version Compatibility:

• SDK Version 4.2501.0 and Later: Starting from SDK version 25.1, all subsequent versions are compatible with API Version v4.0.
• SDK Version 1.2412.0 and Earlier: These versions are compatible with API Version v3.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 Go source code. This SDK allows you to work with Aspose.BarCode for Cloud REST APIs in your Go applications quickly and easily.

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

Prerequisites

To use Aspose.BarCode Cloud SDK for Go you need to register an account with Aspose Cloud and lookup/create Client Secret and SID at Cloud Dashboard. There is a free quota available. For more details, see Aspose Cloud Pricing.

Installation

Using Go Modules (recommended)

1. Go to existing module directory, or create a new module (see https://blog.golang.org/using-go-modules)

2. Run go get command

   go get -u github.com/aspose-barcode-cloud/aspose-barcode-cloud-go@v4.2501.0
   

Using GOPATH (for Go < 1.11 )

1. Run go get command outside module directory

   go get -u github.com/aspose-barcode-cloud/aspose-barcode-cloud-go/barcode
   

Sample usage

Generate an image with barcode

The examples below show how you can generate QR barcode and save it into a local file using barcode:

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/antihax/optional"

	"github.com/aspose-barcode-cloud/aspose-barcode-cloud-go/barcode"
	"github.com/aspose-barcode-cloud/aspose-barcode-cloud-go/barcode/jwt"
)

func main() {
	jwtConf := jwt.NewConfig(
		"Client Id from https://dashboard.aspose.cloud/applications",
		"Client Secret from https://dashboard.aspose.cloud/applications",
	)
	fileName := "testdata/generated.png"

	authCtx := context.WithValue(context.Background(),
		barcode.ContextJWT,
		jwtConf.TokenSource(context.Background()))

	client := barcode.NewAPIClient(barcode.NewConfiguration())

	opts := &barcode.GenerateAPIGenerateOpts{
		TextLocation: optional.NewInterface(barcode.CodeLocationNone),
	}

	data, _, err := client.GenerateAPI.Generate(authCtx,
		barcode.EncodeBarcodeTypeQR,
		"Go SDK example",
		opts)
	if err != nil {
		panic(err)
	}

	out, err := os.Create(fileName)
	if err != nil {
		panic(err)
	}
	defer func(out *os.File) {
		_ = out.Close()
	}(out)

	written, err := out.Write(data)
	if err != nil {
		panic(err)
	}

	fmt.Printf("Written %d bytes to file %s\n", written, fileName)
}

Recognize a barcode on image

The examples below show how you can scan barcode text and type on the image using barcode:

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/aspose-barcode-cloud/aspose-barcode-cloud-go/barcode"
	"github.com/aspose-barcode-cloud/aspose-barcode-cloud-go/barcode/jwt"
)

func main() {
	jwtConf := jwt.NewConfig(
		"Client Id from https://dashboard.aspose.cloud/applications",
		"Client Secret from https://dashboard.aspose.cloud/applications",
	)
	fileName := "testdata/generated.png"

	imageFile, err := os.Open(fileName)
	if err != nil {
		panic(err)
	}
	defer func(file *os.File) {
		_ = file.Close()
	}(imageFile)

	client := barcode.NewAPIClient(barcode.NewConfiguration())
	authCtx := context.WithValue(context.Background(),
		barcode.ContextJWT,
		jwtConf.TokenSource(context.Background()))

	recognized, _, err := client.ScanAPI.ScanMultipart(
		authCtx,
		imageFile)
	if err != nil {
		panic(err)
	}

	if len(recognized.Barcodes) == 0 {
		fmt.Printf("No barcodes in %s", fileName)
	}

	for i, oneBarcode := range recognized.Barcodes {
		fmt.Printf("Recognized #%d: %s %s", i+1, oneBarcode.Type, oneBarcode.BarcodeValue)
	}
}

Dependencies

• github.com/antihax/optional
• github.com/google/uuid
• golang.org/x/oauth2

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

• ApiError
• ApiErrorResponse
• BarcodeImageFormat
• BarcodeImageParams
• BarcodeResponse
• BarcodeResponseList
• CodeLocation
• DecodeBarcodeType
• EncodeBarcodeType
• EncodeData
• EncodeDataType
• GenerateParams
• GraphicsUnit
• RecognitionImageKind
• RecognitionMode
• RecognizeBase64Request
• RegionPoint
• ScanBase64Request