Manage and Optimize a Barcode Recognition Using Cloud Storage

Introduction

Aspose.BarCode for Cloud has provided the simplest API to recognize a barcode and save it on Aspose Cloud Storage. This API can be used with any language: .NET, Java, PHP, Ruby, Rails, Python, jQuery and many more.

API Information

API	Type	Description	Resource Link
/barcode/{name}/recognize	GET	Recognize barcode from a file on server	GetBarcodeRecognize

cURL Example

Request


// First get Access Token
// Get Client Secret and Client Id from https://dashboard.aspose.cloud/

curl -v "https://api.aspose.cloud/connect/token" -X POST -d 'grant_type=client_credentials&client_id=XXXX&client_secret=YYYY' -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"


// cURL example to recognize a barcode

curl -v "https://api.aspose.cloud/v3.0/barcode/sample-barcode.png/recognize?type=Code128&format=png" -X GET -H "Content-Type: application/json" -H "Accept: application/json"

Response


{
  "Barcodes": [
    {
      "BarcodeValue": "AsposeBarCode",
      "BarcodeType": "Code128",
      "Region": [
        "16, 4",
        "371, 4",
        "371, 60",
        "16, 60"
      ],
      "Checksum": ""
    }
  ],
  "Code": 200,
  "Status": "OK"
}

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Checkout our GitHub repository for a complete list of Aspose.BarCode SDKs along with working examples, to get you started in no time.

SDK Examples

Read Barcode from Aspose Cloud Storage

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dotnet/

	string filename = "GetBarcodeRecognize.png";
	string text = "AsposeBarCode";
	string tempfolder = "Temp";
	string presetType = "HighPerformance"

	var barcodesToRecognize = new List<GeneratorParams>
	{
	new GeneratorParams
	{
	TypeOfBarcode = "QR",
	Text = text
	},
	new GeneratorParams
	{
	TypeOfBarcode = "Code128",
	Text = text
	}
	};

	var request = new GetBarcodeRecognizeRequest(
	fileName,
	folder: tempfolder,
	preset: presetType
	);

	BarcodeResponseList response = _api.GetBarcodeRecognize(request);

	// Assert
	Assert.AreEqual(barcodesToRecognize.Count, response.Barcodes.Count);

view raw RecognizeBarcodeFromStorage.cs hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-java/

	String fileName = "sample.png";
	String remoteFolder = uploadFile(fileName);
	String storage = "Storage";

	String type = DecodeBarcodeType.CODE11.getValue();
	String checksumValidation = ChecksumValidation.OFF.toString();
	Boolean detectEncoding = null;
	String preset = PresetType.HIGHPERFORMANCE.toString();
	Integer rectX = null;
	Integer rectY = null;
	Integer rectWidth = null;
	Integer rectHeight = null;
	Boolean stripFNC = null;
	Integer timeout = null;
	Integer medianSmoothingWindowSize = null;
	Boolean allowMedianSmoothing = null;
	Boolean allowComplexBackground = null;
	Boolean allowDatamatrixIndustrialBarcodes = null;
	Boolean allowDecreasedImage = null;
	Boolean allowDetectScanGap = null;
	Boolean allowIncorrectBarcodes = null;
	Boolean allowInvertImage = null;
	Boolean allowMicroWhiteSpotsRemoving = null;
	Boolean allowOneDFastBarcodesDetector = null;
	Boolean allowOneDWipedBarsRestoration = null;
	Boolean allowQRMicroQrRestoration = null;
	Boolean allowRegularImage = null;
	Boolean allowSaltAndPepperFiltering = null;
	Boolean allowWhiteSpotsRemoving = null;
	Double regionLikelihoodThresholdPercent = null;
	List<Integer> scanWindowSizes = null;
	Double similarity = null;
	Boolean skipDiagonalSearch = null;
	String australianPostEncodingTable = null;
	String rectangleRegion = null;

	BarcodeResponseList response =
	api.getBarcodeRecognize(
	fileName,type,checksumValidation,detectEncoding,preset,rectX,rectY,rectWidth,rectHeight,
	stripFNC,timeout,medianSmoothingWindowSize,allowMedianSmoothing,allowComplexBackground,
	allowDatamatrixIndustrialBarcodes,allowDecreasedImage,allowDetectScanGap,allowIncorrectBarcodes,
	allowInvertImage,allowMicroWhiteSpotsRemoving,allowOneDFastBarcodesDetector,allowOneDWipedBarsRestoration,
	allowQRMicroQrRestoration,allowRegularImage,allowSaltAndPepperFiltering,allowWhiteSpotsRemoving,
	regionLikelihoodThresholdPercent,scanWindowSizes,similarity,skipDiagonalSearch,
	australianPostEncodingTable,rectangleRegion,storage,remoteFolder);

	assertNotNull(response);
	assertFalse(response.getBarcodes().isEmpty());

	BarcodeResponse barcode = response.getBarcodes().get(0);
	assertEquals(type, barcode.getType());
	assertEquals("1234567812", barcode.getBarcodeValue());

view raw recognizeBarcodeFromStorage.java hosted with ❤ by GitHub

PHP

	<?
	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-php/
	$fileApi = new FileApi(null, self::$config);
	$path = self::$tempFolderPath . '/' . 'GetBarcodeRecognize.png';
	$uploaded = $fileApi->uploadFile(
	new UploadFileRequest(
	$path,
	new SplFileObject('./data/pdf417Sample.png')
	)
	);
	$this->assertEmpty($uploaded->getErrors(), strval($uploaded));

	$request = new GetBarcodeRecognizeRequest($uploaded->getUploaded()[0]);
	$request->folder = self::$tempFolderPath;

	$response = self::$api->GetBarcoderecognize($request);

	$barcodes = $response->getBarcodes();
	$this->assertCount(1, $barcodes);
	$this->assertEquals(DecodeBarcodeType::Pdf417, $barcodes[0]->getType());
	$this->assertEquals('Aspose.BarCode for Cloud Sample', $barcodes[0]->getBarcodeValue());

view raw Example-RecognizeBarcodeFromStorage.php hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-python

	filename = 'barcode_file.png'
	folder = "Temp"
	presetType = "HighPerformance"

	response = self.api.get_barcode_recognize(filename,
	folder=folder,
	preset=presetType)

	self.assertEqual(1, len(response.barcodes))
	barcode = response.barcodes[0]
	self.assertEqual('Code128', barcode.type)
	self.assertEqual('Hello!', barcode.barcode_value)

view raw recognize_barcode_from_storage.py hosted with ❤ by GitHub

Node.js

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-node/
	const config = LoadConfiguration();
	const api = new Barcode.BarcodeApi(config);
	const fileApi = new Barcode.FileApi(config);

	const tempFolderPath = `BarcodeTests/${uuidv4()}`;
	const filename = 'putBarcodeGenerateFile.png';

	const imageBuffer = fs.readFileSync('./data/pdf417Sample.png');

	it('getBarcodeRecognize should recognize uploaded image', async () => {
	const uploaded = await fileApi.uploadFile(`${tempFolderPath}/${filename}`, imageBuffer); //, "First Storage");

	assert.strictEqual(uploaded.body.errors.length, 0, JSON.stringify(uploaded.body.errors));
	assert.strictEqual(uploaded.body.uploaded[0], filename);

	const recognized = await api.getBarcodeRecognize(
	filename,
	undefined,
	undefined,
	undefined,
	Barcode.PresetType.HighPerformance,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	tempFolderPath
	);

	assert.strictEqual(recognized.body.barcodes.length, 1);
	const barcode = recognized.body.barcodes[0];
	assert.strictEqual(barcode.type, Barcode.DecodeBarcodeType.Pdf417);
	assert.strictEqual(barcode.barcodeValue, 'Aspose.BarCode for Cloud Sample');
	});

view raw Example-RecognizeBarcodeFromStorage.ts hosted with ❤ by GitHub

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-go

	filename := "GetBarcodeRecognize.png"
	folder := "Temp"

	presetType := "HighPerformance"

	client := NewClient()
	ctx := NewAuthContext()

	uploadFile(ctx, t, client, filename)

	recognized, _, err := client.BarcodeApi.GetBarcodeRecognize(ctx, filename, &barcode.BarcodeApiGetBarcodeRecognizeOpts{
	Folder : optional.NewString(folder),
	Preset : optional.NewString(presetType),
	})
	require.Nil(t, err)
	require.Equal(t, 1, len(recognized.Barcodes))
	assert.Equal(t, "Pdf417", recognized.Barcodes[0].Type)
	assert.Equal(t, "Aspose.BarCode Cloud Sample", recognized.Barcodes[0].BarcodeValue)
	require.Equal(t, 4, len(recognized.Barcodes[0].Region))
	assert.Greater(t, recognized.Barcodes[0].Region[0].X, int32(0))
	assert.Greater(t, recognized.Barcodes[0].Region[0].Y, int32(0))

view raw RecognizeBarcodeFromStorage.go hosted with ❤ by GitHub

Read Barcode from Specific Region of Image

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-dotnet/

	string filename = "GetBarcodeRecognize.png";
	string text = "AsposeBarCode";
	string tempfolder = "Temp";

	var barcodesToRecognize = new List<GeneratorParams>
	{
	new GeneratorParams
	{
	TypeOfBarcode = "QR",
	Text = text
	},
	new GeneratorParams
	{
	TypeOfBarcode = "Code128",
	Text = text
	}
	};

	var request = new GetBarcodeRecognizeRequest(
	fileName,
	folder: tempfolder,
	rectX: 10,
	rectY: 10,
	rectWidth: 200,
	rectHeight: 200,
	checksumValidation: "On",
	stripFNC: true,
	);

	BarcodeResponseList response = _api.GetBarcodeRecognize(request);

	// Assert
	Assert.AreEqual(barcodesToRecognize.Count, response.Barcodes.Count);

	foreach ((GeneratorParams generated, BarcodeResponse recognized) in
	barcodesToRecognize.Zip(response.Barcodes,
	(generated, recognized) => (generated, recognized)))
	{
	Assert.AreEqual(generated.TypeOfBarcode.ToString(), recognized.Type);
	Assert.AreEqual(generated.Text, recognized.BarcodeValue);
	}

view raw ReadBarcodeFromSpecificRegion.cs hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-java/

	String fileName = "sample.png";
	String remoteFolder = uploadFile(fileName);
	String storage = "Storage";

	String type = DecodeBarcodeType.CODE11.getValue();
	String checksumValidation = ChecksumValidation.OFF.toString();
	Boolean detectEncoding = null;
	String preset = PresetType.HIGHPERFORMANCE.toString();
	Integer rectX = 10;
	Integer rectY = 10;
	Integer rectWidth = 200;
	Integer rectHeight = 200;
	Boolean stripFNC = true;

	Integer timeout = null;
	Integer medianSmoothingWindowSize = null;
	Boolean allowMedianSmoothing = null;
	Boolean allowComplexBackground = null;
	Boolean allowDatamatrixIndustrialBarcodes = null;
	Boolean allowDecreasedImage = null;
	Boolean allowDetectScanGap = null;
	Boolean allowIncorrectBarcodes = null;
	Boolean allowInvertImage = null;
	Boolean allowMicroWhiteSpotsRemoving = null;
	Boolean allowOneDFastBarcodesDetector = null;
	Boolean allowOneDWipedBarsRestoration = null;
	Boolean allowQRMicroQrRestoration = null;
	Boolean allowRegularImage = null;
	Boolean allowSaltAndPepperFiltering = null;
	Boolean allowWhiteSpotsRemoving = null;
	Double regionLikelihoodThresholdPercent = null;
	List<Integer> scanWindowSizes = null;
	Double similarity = null;
	Boolean skipDiagonalSearch = null;
	String australianPostEncodingTable = null;
	String rectangleRegion = null;

	BarcodeResponseList response =
	api.getBarcodeRecognize(
	fileName,type,checksumValidation,detectEncoding,preset,rectX,rectY,rectWidth,rectHeight,
	stripFNC,timeout,medianSmoothingWindowSize,allowMedianSmoothing,allowComplexBackground,
	allowDatamatrixIndustrialBarcodes,allowDecreasedImage,allowDetectScanGap,allowIncorrectBarcodes,
	allowInvertImage,allowMicroWhiteSpotsRemoving,allowOneDFastBarcodesDetector,allowOneDWipedBarsRestoration,
	allowQRMicroQrRestoration,allowRegularImage,allowSaltAndPepperFiltering,allowWhiteSpotsRemoving,
	regionLikelihoodThresholdPercent,scanWindowSizes,similarity,skipDiagonalSearch,
	australianPostEncodingTable,rectangleRegion,storage,remoteFolder);

	assertNotNull(response);
	assertFalse(response.getBarcodes().isEmpty());

	BarcodeResponse barcode = response.getBarcodes().get(0);
	assertEquals(type, barcode.getType());
	assertEquals("1234567812", barcode.getBarcodeValue());

view raw readBarcodeFromSpecificRegion.java hosted with ❤ by GitHub

PHP

	<?
	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-php/
	$fileApi = new FileApi(null, self::$config);
	$path = self::$tempFolderPath . '/' . 'GetBarcodeRecognize.png';
	$uploaded = $fileApi->uploadFile(
	new UploadFileRequest(
	$path,
	new SplFileObject('./data/pdf417Sample.png')
	)
	);
	$this->assertEmpty($uploaded->getErrors(), strval($uploaded));

	$request = new GetBarcodeRecognizeRequest($uploaded->getUploaded()[0]);
	$request->folder = self::$tempFolderPath;
	$request->rect_x = 10;
	$request->rect_y = 10;
	$request->rect_width = 200;
	$request->rect_height = 200;
	$request->checksum_validation = 'On'
	$request->strip_fnc = true;

	$response = self::$api->GetBarcoderecognize($request);

	$barcodes = $response->getBarcodes();
	$this->assertCount(1, $barcodes);
	$this->assertEquals(DecodeBarcodeType::Pdf417, $barcodes[0]->getType());
	$this->assertEquals('Aspose.BarCode for Cloud Sample', $barcodes[0]->getBarcodeValue());

view raw Example-ReadBarcodeFromSpecificRegion.php hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-python

	filename = 'barcode_file.png'
	folder = "Temp"
	presetType = "HighPerformance"

	checksumValidation = "On"
	stripFnc = True

	rectX = 10
	rectY = 10
	rectWidth = 200
	rectHeight = 200

	response = self.api.get_barcode_recognize(filename,
	folder=folder,
	preset=presetType,
	rect_x=rectX,
	rect_y=rectY,
	rect_width=
	rectWidth,
	rect_height=rectHeight,
	checksum_validation=checksumValidation,
	strip_fnc=stripFnc)

	self.assertEqual(1, len(response.barcodes))
	barcode = response.barcodes[0]
	self.assertEqual('Code128', barcode.type)
	self.assertEqual('Hello!', barcode.barcode_value)

view raw read_barcode_from_specific_region.py hosted with ❤ by GitHub

Node.js

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-node/
	const config = LoadConfiguration();
	const api = new Barcode.BarcodeApi(config);
	const fileApi = new Barcode.FileApi(config);

	const tempFolderPath = `BarcodeTests/${uuidv4()}`;
	const filename = 'putBarcodeGenerateFile.png';

	const imageBuffer = fs.readFileSync('./data/pdf417Sample.png');

	const rect_x = 10;
	const rect_y = 10;
	const rect_width = 200;
	const rect_height = 200;
	const checksum_validation = 'On'
	const strip_fnc = true;

	it('getBarcodeRecognize should recognize uploaded image', async () => {
	const uploaded = await fileApi.uploadFile(`${tempFolderPath}/${filename}`, imageBuffer); //, "First Storage");

	assert.strictEqual(uploaded.body.errors.length, 0, JSON.stringify(uploaded.body.errors));
	assert.strictEqual(uploaded.body.uploaded[0], filename);

	const recognized = await api.getBarcodeRecognize(
	filename,
	undefined,
	checksum_validation,
	undefined,
	Barcode.PresetType.HighPerformance,
	rect_x,
	rect_y,
	rect_width,
	rect_height,
	strip_fnc,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	undefined,
	tempFolderPath
	);

	assert.strictEqual(recognized.body.barcodes.length, 1);
	const barcode = recognized.body.barcodes[0];
	assert.strictEqual(barcode.type, Barcode.DecodeBarcodeType.Pdf417);
	assert.strictEqual(barcode.barcodeValue, 'Aspose.BarCode for Cloud Sample');
	});

view raw Example-ReadBarcodeFromSpecificRegion.ts hosted with ❤ by GitHub

	// For complete examples and data files, please go to https://github.com/aspose-barcode-cloud/aspose-barcode-cloud-go

	filename := "GetBarcodeRecognize.png"
	folder := "Temp"

	checksumValidation := "On"

	client := NewClient()
	ctx := NewAuthContext()

	uploadFile(ctx, t, client, filename)

	recognized, _, err := client.BarcodeApi.GetBarcodeRecognize(ctx, filename, &barcode.BarcodeApiGetBarcodeRecognizeOpts{
	Folder : optional.NewString(folder),
	RectX : optional.NewInt32(10),
	RectY : optional.NewInt32(10),
	RectWidth : optional.NewInt32(200),
	RectHeight : optional.NewInt32(200),
	ChecksumValidation : optional.NewString(checksumValidation),
	StripFNC : optional.NewBool(true),
	})
	require.Nil(t, err)
	require.Equal(t, 1, len(recognized.Barcodes))
	assert.Equal(t, "Pdf417", recognized.Barcodes[0].Type)
	assert.Equal(t, "Aspose.BarCode Cloud Sample", recognized.Barcodes[0].BarcodeValue)
	require.Equal(t, 4, len(recognized.Barcodes[0].Region))
	assert.Greater(t, recognized.Barcodes[0].Region[0].X, int32(0))
	assert.Greater(t, recognized.Barcodes[0].Region[0].Y, int32(0))

view raw ReadBarcodeFromSpecificRegion.go hosted with ❤ by GitHub

Manage and Optimize a Barcode Recognition Without Cloud Storage