BarcodePro Web API for Docker

REST API to Generate High-Quality GS1-ISO-Compliance Barcodes


Key Features

  Linear, Postal & 2D Barcode Symbologies
  REST API running Linux Docker container
  High Quality PNG, JPEG, SVG, EPS, PDF & more!
  GS1, ISO/IEC & AIM Spec Compliance

  Download   Buy

Advanced Barcode Generator for Docker

BarcodePro Web API for Docker generates barcode images that can be used from Any Development Platform and Programming Languages (.NET, Java, PHP, Javascript, Python, Ruby, and more!). After specifying a Value to encode, choosing a Barcode Symbology, and setting some simple properties, BarcodePro Web API will generate the barcode symbol in the specified image or document format like JPEG/JPG, PNG, PCX, SVG, EPS, and PDF!


Features at a Glance

   Linear (1D), Postal, Stacked & 2D Barcodes

BarcodePro Web API for Docker supports most popular Linear (1D), Postal, Component Composite & 2D Barcode Symbologies all-in-one solution including Code 39, Code 128, GS1-128, GS1 DataBar (RSS-14), EAN 13 & UPC, Postal (USPS, British Royal Mail, Australia Post, DHL, FedEx, Japan), Data Matrix (DMRE), QR Code, PDF 417, Aztec Code, UPS MaxiCode, Chinese Han Xin Code, IFA PPN, all EAN/UPC Composite Barcodes (CC-A, CC-B & CC-C), Mailmark, DotCode, Swiss-QRCode, JAB-Code Multicolored 2D Matrix and many more barcode standards

GS1-AIM-ISO/IEC Compliance

Our barcode algorithms were written by following the official specifications of each barcode symbology. Our barcode engine provides you with exclusive features like auto-checksum, data validation, Bar Width Adjustment (BWA) for linear & 2D symbols, auto-encoding methods for shortest barcode symbol generation.

Best-in-class Imaging Support

BarcodePro Web API for Docker creates barcodes in raster formats like PNG, JPEG/JPG, PCX & PDF as well as in SVG & EPS vector formats! All barcode can be rotated at 90, 180 & 270 degrees. Rounded Border & Beader Bars are also supported. High Quality DPI Resolution is supported for PNG & JPEG outputs.

Create Artistic Barcodes

Create customized barcodes by stamping logos or pictures on symbols as well as specifying an image for filling the bars or dots!
Artistic Barcodes with logo & fill patterns

Overview

Designed by following some of the REST principles, BarcodePro Web API for Docker responds to a simple HTTP POST by specifying the Barcode settings through a JSON object in the request body, returning the output rendering in the image or document format specified through the Accept header.

Help Doc Topics


Download and run BarcodePro Web API for Docker

BarcodePro Web API for Docker is available at Docker Hub registry.

  • To pull/download the Docker image, please type the following from a Terminal:

    docker pull neodynamic/barcodeprowebapi:1.0.1
  • To run the Docker image, please type the following from a Terminal:

    docker run -it --rm -p 8080:80 neodynamic/barcodeprowebapi:1.0.1

How To Use It - Basic Sample

The following source code invokes the BarcodePro Web API for Docker to generate a PNG image for the specified Barcode JSON object (in this simple example we'll request a QRCode encoding 12345). For more advanced settings please refer to the Barcode JSON Object

                    
curl -X POST "http://localhost:8080/BarcodeGenerator" \
     -H  "Accept: image/png" \
     -H  "Content-Type: application/json" \
     -d "{\"symbology\":\"QRCode\", \"code\":\"12345\"}" \
     --output label.png
                        
                
                    
$data = array(
  'symbology' => 'QRCode',
  'code' => '12345'
);

$options = array(
  'http' => array(
    'method'  => 'POST',
    'content' => json_encode( $data ),
    'header' =>  "Content-Type: application/json\r\n" .
                "Accept: image/png\r\n"
    )
);

$context  = stream_context_create( $options );
$url = 'http://localhost:8080/BarcodeGenerator';
$response = file_get_contents( $url, false, $context );
file_put_contents('label.png', $response);
                        
                
                    
require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("http://localhost:8080/BarcodeGenerator")

header = {'Accept':'image/png', 'Content-Type': 'application/json'}

data = {symbology: 'QRCode', code: '12345'}

http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri, header)
request.body = data.to_json

response = http.request(request)

open('/tmp/label.png', 'wb' ) { |file|
    file.write(response.body)
}
                        
                
                    
import requests
import json

url = "http://localhost:8080/BarcodeGenerator"

jsondata = json.dumps( {"symbology": "QRCode", "code": "12345"} )

headers = {
    'content-type': "application/json",
    'accept': "image/png"
    }

response = requests.request("POST", url, data=jsondata, headers=headers)

if response.status_code == 200:
    with open("label.png", 'wb') as f:
        f.write(response.content)

                        
                
                    
use LWP::UserAgent;
my $ua = LWP::UserAgent->new;
my $server_endpoint = "http://localhost:8080/BarcodeGenerator";
my $req = HTTP::Request->new(POST => $server_endpoint);
$req->header('content-type' => 'application/json');
$req->header('accept' => 'image/png');

my $post_data = '{ "symbology" : "QRCode", "code" : "12345" }';

$req->content($post_data);

my $resp = $ua->request($req);
open FILEHANDLE, ">label.png";
print FILEHANDLE $resp->{_content};
close FILEHANDLE;
                        
                
                    
CloseableHttpClient client = HttpClients.createDefault();
HttpPost httpPost = new HttpPost("http://localhost:8080/BarcodeGenerator");
 
String json = "{\"symbology\" : \"QRCode\", \"code\": \"12345\"}";
StringEntity entity = new StringEntity(json);
httpPost.setEntity(entity);
httpPost.setHeader("Accept", "image/png");
httpPost.setHeader("Content-type", "application/json");
 
CloseableHttpResponse response = client.execute(httpPost);
HttpEntity entity = response.getEntity();
if (entity != null) {
    try (FileOutputStream outstream = new FileOutputStream(new File("label.png"))) {
        entity.writeTo(outstream);
    }
}
client.close();     
                        
                
                    
string DATA = "{\"symbology\" : \"QRCode\", \"code\": \"12345\"}";

var request = (HttpWebRequest)WebRequest.Create("http://localhost:8080/BarcodeGenerator");
request.Method = "POST";
request.ContentType = "application/json";
request.ContentLength = DATA.Length;
request.Accept = "image/png";

using (var requestWriter = new StreamWriter(request.GetRequestStream(), System.Text.Encoding.ASCII)){
    requestWriter.Write(DATA);
}

var webResponse = request.GetResponse();
using (var stream = webResponse.GetResponseStream())
using (var fileStream = File.OpenWrite("label.png"))
{
    var bytes = new byte[4096];
    var read=0;
    do
    {
        if (stream == null) {continue;}
        read = stream.Read(bytes, 0, bytes.Length);
        fileStream.Write(bytes, 0, read);
    } while (read != 0);
}

                        
                
                    
var data = JSON.stringify({
    "symbology": "QRCode",
    "code": "12345"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
    if (this.readyState === 4) {
    console.log(this.responseText);
    }
});

xhr.open("POST", "http://localhost:8080/BarcodeGenerator");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("accept", "image/png");

xhr.send(data);
                        
                
                    
var request = require('request');
 
var headers = {
    'Accept': 'image/png',
    'Content-Type': 'application/json'
}
 
var options = {
    url: 'http://localhost:8080/BarcodeGenerator',
    method: 'POST',
    headers: headers,
    json: {"symbology": "QRCode", "code": "12345"}
}
 
request(options, function (error, response, body) {
    if (!error && response.statusCode == 200) {
        console.log(body);
    }
})
                        
                

Postman Samples for MaxiCode, QR Code, Code-128 & PDF417

MaxiCode Barcode
QR Code Barcode
Code-128 Barcode
PDF417 Barcode

The Barcode JSON Object

The Barcode is a JSON Object that specifies the Barcode Settings like Symbology (Barcode Type), Code (value to encode), DPI, Width & Height, Bars Color, Text Font & Color, and more.

Barcode JSON

{
  "symbology": "Code128",
  "code": "string",
  "isCodeBase64": false,
  "codeBase64EncodingName": "string",
  "barcodeUnit": "Inch",
  "dpi": 0,
  "height": 0,
  "width": 0,
  "addChecksum": true,
  "antiAlias": true,
  "artBarImagePattern": "string",
  "artLogoImage": "string",
  "artLogoImageOpacity": 0,
  "artLogoImagePercentage": 0,
  "artLogoImagePosition": "Top",
  "autoSize": true,
  "aztecCodeByteEncodingName": "string",
  "aztecCodeErrorCorrection": 0,
  "aztecCodeFormat": "Auto",
  "aztecCodeModuleSize": 0,
  "aztecCodeProcessTilde": false,
  "aztecCodeRune": 0,
  "backColor": "string",
  "barcodePaddingBottom": 0,
  "barcodePaddingLeft": 0,
  "barcodePaddingRight": 0,
  "barcodePaddingTop": 0,
  "barColor": "string",
  "barHeight": 0,
  "barRatio": 0,
  "barWidth": 0,
  "barWidthAdjustment": 0,
  "bearerBarStyle": "None",
  "bearerBarWidth": 0,
  "borderColor": "string",
  "borderRadius": 0,
  "borderWidth": 0,
  "bottomMargin": 0,
  "channelCode": 0,
  "codabarStartChar": "A",
  "codabarStopChar": "A",
  "code11TwoDigitsChecksum": false,
  "code128CharSet": "Auto",
  "code16kMode": "Mode0",
  "code39FullAsciiMode": true,
  "code93FullAsciiMode": true,
  "codeAlignment": "BelowCenter",
  "codeFormatPattern": "string",
  "dataMatrixByteEncodingName": "string",
  "dataMatrixEncoding": "Auto",
  "dataMatrixFileId": "string",
  "dataMatrixFormat": "Auto",
  "dataMatrixIncludeRectFormatsInAutoMode": false,
  "dataMatrixModuleSize": 0,
  "dataMatrixProcessTilde": false,
  "dataMatrixSymbolCount": 0,
  "dataMatrixSymbolIndex": 0,
  "displayChecksum": true,
  "displayCode": true,
  "displayLightMarginIndicator": true,
  "displayStartStopChar": true,
  "dotCodeAspectRatio": "string",
  "dotCodeColumns": 0,
  "dotCodeModuleShape": "Circle",
  "dotCodeModuleSize": 0,
  "dotCodeProcessTilde": false,
  "dotCodeRows": 0,
  "eanUpcAutoBWAfor1278DigitsEnabled": false,
  "eanUpcMagnificationFactor": 0,
  "eanUpcSupplement": "None",
  "eanUpcSupplementCode": "string",
  "eanUpcSupplementSeparation": 0,
  "eanUpcSupplementTopMargin": 0,
  "fitProportional": false,
  "fontBold": false,
  "fontItalic": false,
  "fontName": "string",
  "fontSizeInPoints": 0,
  "fontStrikeout": false,
  "fontUnderline": false,
  "foreColor": "string",
  "gS1DataStrictValidation": false,
  "guardBar": true,
  "guardBarHeight": 0,
  "hanXinCodeByteEncodingName": "string",
  "hanXinCodeEncoding": "Auto",
  "hanXinCodeErrorCorrectionLevel": "L1",
  "hanXinCodeModuleSize": 0,
  "hanXinCodeProcessTilde": false,
  "hanXinCodeVersion": "Auto",
  "hibcFormatHumanReadableText": true,
  "hibcUseIsoIec15434Encoding": false,
  "humanReadableText": "string",
  "isbt128DataStructure": "DS001",
  "itf14LeftHMark": "None",
  "itf14RightHMark": "None",
  "jabCodeColors": 0,
  "jabCodeModuleSize": 0,
  "jabCodeSymbolCount": 0,
  "jabCodeSymbolEccLevel": "string",
  "jabCodeSymbolPosition": "string",
  "jabCodeSymbolVersion": "string",
  "maxiCodeDrawPixelBasedSymbol": false,
  "maxiCodeMode": "Mode3",
  "maxiCodeProcessTilde": false,
  "maxiCodeSymbolCount": 0,
  "maxiCodeSymbolIndex": 0,
  "microPdf417Version": "Auto",
  "microQRCodeVersion": "Auto",
  "msiChecksum": "OneMod10",
  "pdf417AspectRatio": 0,
  "pdf417ByteEncodingName": "string",
  "pdf417Columns": 0,
  "pdf417CompactionType": "Auto",
  "pdf417ErrorCorrectionLevel": "Level2",
  "pdf417FileId": "string",
  "pdf417Rows": 0,
  "pdf417SegmentCount": 0,
  "pdf417SegmentIndex": 0,
  "pdf417Truncated": false,
  "pharmacode2DColorField1": "string",
  "pharmacode2DColorField2": "string",
  "pharmacode2DColorField3": "string",
  "pharmacode2DColorField4": "string",
  "pharmacode2DColorField5": "string",
  "pharmacode2DColorField6": "string",
  "pharmacode2DColorField7": "string",
  "pharmacode2DColorField8": "string",
  "pharmacode2DColorFields": "Standard",
  "pharmacode2DTriggerMark": "Left",
  "pharmacodeBarsSpacing": 0,
  "pharmacodeThickBarWidth": 0,
  "pharmacodeThinBarWidth": 0,
  "planetHeightShortBar": 0,
  "planetHeightTallBar": 0,
  "postal4StateAddStartStopChar": true,
  "postal4StateBarsSpacing": 0,
  "postal4StateTrackerBarHeight": 0,
  "postal4StateTrackerBarWidth": 0,
  "postnetHeightShortBar": 0,
  "postnetHeightTallBar": 0,
  "qrCodeByteEncodingName": "string",
  "qrCodeEncoding": "Auto",
  "qrCodeErrorCorrectionLevel": "M",
  "qrCodeModuleSize": 0,
  "qrCodeProcessTilde": false,
  "qrCodeVersion": "Auto",
  "quietZoneWidth": 0,
  "rotate": "None",
  "segmentsPerRow": 0,
  "snapsToDevicePixels": false,
  "telepenEncoding": "Ascii",
  "text": "string",
  "textAlignment": "AboveCenter",
  "textFontBold": false,
  "textFontItalic": false,
  "textFontName": "string",
  "textFontSizeInPoints": 0,
  "textFontStrikeout": false,
  "textFontUnderline": false,
  "textForeColor": "string",
  "textFormatPattern": "string",
  "tlc39MicroPdf417BarWidth": 0,
  "tlc39MicroPdf417RowBarHeight": 0,
  "topMargin": 0,
  "upcESystem": "System0",
  "useQuietZoneForText": false,
  "uspsFimPattern": "A",
  "uspsHorizontalBarsCount": 0
}
Attributes
symbology  REQUIRED  string  default: Code128
Gets or sets the barcode symbology to generate. Further info at https://neodynamic.com/barcodes

Enum
[ Codabar, Code11, Code16k, Code39, Code93, Code128, DataMatrix, Ean8, Ean13, Industrial2of5, Interleaved2of5, Isbn, Msi, Pdf417, Planet, Postnet, UccEan128, UpcA, UpcE, UspsOneCode4CB, RoyalMail, AustraliaPost, RoyalTpgPostKix, Sscc18, Pzn, DeutschePostLeitcode, DeutschePostIdentcode, UspsTrayLabel, UspsSackLabel, EanVelocity, SingaporePost, Jan8, Jan13, SwissPostParcel, Opc, Ean99, Itf14, Scc14, Issn, Ismn, NumlyNumber, QRCode, UspsFim, UspsHorizontalBars, Telepen, Pharmacode, Semacode, Code32, UspsPicUccEan128, FedExGround96, AztecCode, CompactPdf417, MacroPdf417, MicroPdf417, VicsBol, VicsScacPro, ItalianPost25, Isbt128, HibcLic39, HibcLic128, HibcPas39, HibcPas128, UspsIntelligentMail, EanUpcAddOn2, EanUpcAddOn5, UspsPicCode128, GS1DataBarOmnidirectional, GS1DataBar14, Rss14, GS1DataBarTruncated, GS1DataBar14Truncated, Rss14Truncated, GS1DataBarStacked, GS1DataBar14Stacked, Rss14Stacked, GS1DataBarStackedOmnidirectional, GS1DataBar14StackedOmnidirectional, Rss14StackedOmnidirectional, GS1DataBarLimited, RssLimited, GS1DataBarExpanded, RssExpanded, GS1DataBarExpandedStacked, RssExpandedStacked, GS1128, MaxiCode, MicroQRCode, Matrix2of5, DanishPostal39, FrenchPostal39AR, IATA2of5, AustraliaPostDomesticEParcelBarcode, UspsIntelligentMailContainerBarcode, KodakPatchCode, GS1DataMatrix, Ean13CCA, Ean13CCB, Ean8CCA, Ean8CCB, UpcACCA, UpcACCB, UpcECCA, UpcECCB, UccEan128CCA, UccEan128CCB, UccEan128CCC, GS1128CCA, GS1128CCB, GS1128CCC, GS1DataBarOmnidirectionalCCA, GS1DataBar14CCA, Rss14CCA, GS1DataBarOmnidirectionalCCB, GS1DataBar14CCB, Rss14CCB, GS1DataBarTruncatedCCA, GS1DataBar14TruncatedCCA, Rss14TruncatedCCA, GS1DataBarTruncatedCCB, GS1DataBar14TruncatedCCB, Rss14TruncatedCCB, GS1DataBarLimitedCCA, RssLimitedCCA, GS1DataBarLimitedCCB, RssLimitedCCB, GS1DataBarStackedCCA, GS1DataBar14StackedCCA, Rss14StackedCCA, GS1DataBarStackedCCB, GS1DataBar14StackedCCB, Rss14StackedCCB, GS1DataBarStackedOmnidirectionalCCA, GS1DataBar14StackedOmnidirectionalCCA, Rss14StackedOmnidirectionalCCA, GS1DataBarStackedOmnidirectionalCCB, GS1DataBar14StackedOmnidirectionalCCB, Rss14StackedOmnidirectionalCCB, GS1DataBarExpandedCCA, RssExpandedCCA, GS1DataBarExpandedCCB, RssExpandedCCB, GS1DataBarExpandedStackedCCA, RssExpandedStackedCCA, GS1DataBarExpandedStackedCCB, RssExpandedStackedCCB, Ean14, Dun14Itf, Dun14Ean, GS1QRCode, Ppn, IFAsecurPharm, DhlAwb, HibcLicDataMatrix, HibcLicQRCode, HibcLicAztecCode, HibcPasDataMatrix, HibcPasQRCode, HibcPasAztecCode, Isbt128DataMatrix, DeutschePostResponsePlusPostMatrix, DeutschePostBzl, UspsIntelligentMailPackageBarcode, HanXinCode, JapanPost, KoreaPost, DataLogic2of5, MailmarkCMDM, Mailmark4StateC, Mailmark4StateL, DotCode, GS1AztecCode, SwissQRCode, Pharmacode2D, ChannelCode, JABCode, Plessey, EPCQRCode, Code49, CodablockF, Tlc39, HibcLicCodablockF, HibcPasCodablockF, TriOptic, DINSpecQRCode, DINSpecDataMatrix ]
code  REQUIRED  string  default: 12345
Gets or sets the value to encode.
isCodeBase64  boolean  default: false
Whether the specified value to encode in the code property is in Base64 format. Useful for encoding non-readable/printable chars.
codeBase64EncodingName  string  default: ISO-8859-1  nullable: true
The Encoding or CodePage Identifier/Name of the value to encode in the code property when isCodeBase64 is enabled. Default is ISO-8859-1. Valid values...
barcodeUnit  string  default: Inch
Gets or sets the unit of measure for the barcode dimensions.

Enum
[ Inch, Millimeter, Centimeter, Mils ]
dpi  number ($double)  default: 96
Gets or sets the DPI (dots per inch) or Resolution of the output barcode image.
height  number ($double)  default: 1
Gets or sets the height of the barcode image if autoSize property is not enabled. The unit of measure must be specified to barcodeUnit property.
width  number ($double)  default: 2
Gets or sets the width of the barcode image if autoSize property is not enabled. The unit of measure must be specified to barcodeUnit property.
addChecksum  boolean  default: true
Gets or sets whether checksum must be generated and attached to the value to encode.
antiAlias  boolean  default: true
Gets or sets whether AntiAlias effect must be applied to all the texts in the barcode image.
artBarImagePattern  string  nullable: true
Gets or sets the image file (path or Base64 string) that will be used as a pattern to fill all the bars that compose the barcode symbol.
artLogoImage  string  nullable: true
Gets or sets the logo image file (path or Base64 string) that will be used to stamp it on top or bottom of the barcode symbol. Note: this feature is not available when exporting the barcode symbol to EPS format.
artLogoImageOpacity  integer ($int32)  default: 100
Gets or sets the opacity [from 1 to 100 (fully opaque)] of the image logo file.
artLogoImagePercentage  integer ($int32)  default: 20
Gets or sets the percentage used to resize the logo image based on the barcode symbol size.
artLogoImagePosition  string  default: Top
Gets or sets the position of the logo image file on the barcode symbol. Default is Top.

Enum
[ Top, Bottom ]
autoSize  boolean  default: true
Gets or sets whether the barcode image is automatically resized to display its entire contents.
aztecCodeByteEncodingName  string  default: ISO-8859-1  nullable: true
Gets or sets the Encoding Name (Code Page) to be used for Aztec Code in Byte Compaction mode.
aztecCodeErrorCorrection  integer ($int32)  default: 23
Gets or sets the Error Correction Percentage to apply for Aztec Code symbology.
aztecCodeFormat  string  default: Auto
Gets or sets the Aztec Code Format to use on that symbology.

Enum
[ Auto, C15X15Compact, C19X19, C19X19Compact, C23X23, C23X23Compact, C27X27, C27X27Compact, C31X31, C37X37, C41X41, C45X45, C49X49, C53X53, C57X57, C61X61, C67X67, C71X71, C75X75, C79X79, C83X83, C87X87, C91X91, C95X95, C101X101, C105X105, C109X109, C113X113, C117X117, C121X121, C125X125, C131X131, C135X135, C139X139, C143X143, C147X147, C151X151 ]
aztecCodeModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
aztecCodeProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when Aztec Code is being generated.
aztecCodeRune  integer ($int32)  default: 0
Gets or sets the Aztec Code Rune value. It must be a value from 0 to 255 and is available for Aztec Code Compact Format only.
backColor  string  default: #fff  nullable: true
Gets or sets the background color in hex notation.
barcodePaddingBottom  number ($double)  default: 0
Gets or sets the bottom extra space inside the container's border. The unit of measure must be specified to barcodeUnit property.
barcodePaddingLeft  number ($double)  default: 0
Gets or sets the left extra space inside the container's border. The unit of measure must be specified to barcodeUnit property.
barcodePaddingRight  number ($double)  default: 0
Gets or sets the right extra space inside the container's border. The unit of measure must be specified to barcodeUnit property.
barcodePaddingTop  number ($double)  default: 0
Gets or sets the top extra space inside the container's border. The unit of measure must be specified to barcodeUnit property.
barColor  string  default: #000  nullable: true
Gets or sets the bars' color of the barcode in hex notation.
barHeight  number ($double)  default: 1
Gets or sets the bars' height of the barcode. The unit of measure must be specified to barcodeUnit property.
barRatio  number ($double)  default: 2
Gets or sets the wide bars' width compared to the narrow bars' width. In barcode terminology this is called N value.
barWidth  number ($double)  default: 0.0104
Gets or sets the narrow bars' width of the barcode. In barcode terminology this is called X value. The unit of measure must be specified to barcodeUnit property.
barWidthAdjustment  number ($double)  default: 0
Gets or sets the Bar Width Adjustment.
bearerBarStyle  string  default: None
Gets or set the bearer bars' type that must be drawn with the barcode image. Bearer bar is only available for 2 of 5, Code 128 and UCC.EAN 128 barcodes.

Enum
[ None, Frame, HorizontalRules ]
bearerBarWidth  number ($double)  default: 0.05
Gets or sets the bearer bars' width. The unit of measure must be specified to barcodeUnit property.
borderColor  string  default: #000  nullable: true
Gets or sets the barcode border's colorin hex notation.
borderRadius  number ($double)  default: 0
Gets or sets the barcode border's radius. The unit of measure must be specified to barcodeUnit property.
borderWidth  number ($double)  default: 0
Gets or sets the barcode border's width. The unit of measure must be specified to barcodeUnit property.
bottomMargin  number ($double)  default: 0
Gets or sets the height of the margin below the barcode bars. The unit of measure must be specified to barcodeUnit property.
channelCode  integer ($int32)  default: 8
Gets or sets the Channel Code. Its value must be from 3 up to 8. Each channel code supports its own range of values: Channel 3 [0-26], Channel 4 [0-292], Channel 5 [0-3493], Channel 6 [0-44072], Channel 7 [0-576688], and Channel 8 [0-7742862]
codabarStartChar  string  default: A
Gets or sets the start character for Codabar symbology. Possible values are: A, B, C or D.

Enum
[ A, B, C, D ]
codabarStopChar  string  default: A
Gets or sets the stop character for Codabar symbology. Possible values are: A, B, C or D.

Enum
[ A, B, C, D ]
code11TwoDigitsChecksum  boolean  default: false
Gets or sets whether Code 11 two digits checksum must be calculated and encoded.
code128CharSet  string  default: Auto
Gets or sets the characters set to use in the Code 128 symbology. Possible values are: Auto, A, B or C.

Enum
[ Auto, A, B, C ]
code16kMode  string  default: Mode0
Gets or sets the mode to use for Code16k symbology. Modes supported are: Mode 0, 1, and 2.

Enum
[ Mode0, Mode1, Mode2 ]
code39FullAsciiMode  boolean  default: true
Gets or sets whether the extended versions for Code 39 symbologies must be used.
code93FullAsciiMode  boolean  default: true
Gets or sets whether the extended versions for Code 93 symbologies must be used.
codeAlignment  string  default: BelowCenter
Gets or sets the text alignment for code and humanReadableText properties.

Enum
[ AboveCenter, AboveLeft, AboveRight, AboveJustify, BelowCenter, BelowLeft, BelowRight, BelowJustify ]
codeFormatPattern  string  default:   nullable: true
Gets or sets the string pattern to format the code property. The result of the format process is the one which will be encoded!
dataMatrixByteEncodingName  string  default: ISO-8859-1  nullable: true
Gets or sets the Encoding Name (Code Page) to be used for DataMatrix in Byte Compaction mode.
dataMatrixEncoding  string  default: Auto
Gets or sets the DataMatrix Encoding to use on that symbology.

Enum
[ Auto, Ascii, C40, Text, Base256, AnsiX12, EDIFACT ]
dataMatrixFileId  string  default: 001001  nullable: true
Gets or sets the File ID of the Data Matrix symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 001 and 254) and must be the same for all data segments.
dataMatrixFormat  string  default: Auto
Gets or sets the DataMatrix Format to use on that symbology.

Enum
[ Auto, AutoDMRE, C10X10, C12X12, C8X18, C14X14, C8X32, C16X16, C12X26, C18X18, C20X20, C12X36, C22X22, C16X36, C24X24, C26X26, C16X48, C32X32, C36X36, C40X40, C44X44, C48X48, C52X52, C64X64, C72X72, C80X80, C88X88, C96X96, C104X104, C120X120, C132X132, C144X144, DMRE8X48, DMRE8X64, DMRE12X64, DMRE24X32, DMRE26X32, DMRE24X36, DMRE16X64, DMRE26X40, DMRE24X48, DMRE26X48, DMRE24X64, DMRE26X64 ]
dataMatrixIncludeRectFormatsInAutoMode  boolean  default: false
Gets or sets whether to consider Rectangular DataMatrix Formats when DataMatrixFormat is set to Auto.
dataMatrixModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
dataMatrixProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when DataMatrix code is being generated.
dataMatrixSymbolCount  integer ($int32)  default: 1
Gets or sets the number of Data Matrix symbols. Its value must be less than or equal to 16.
dataMatrixSymbolIndex  integer ($int32)  default: 1
Gets or sets the Index for a Data Matrix symbol. Its value must be 1 up to 16 and must be less than or equal to the value in dataMatrixSegmentCount property.
displayChecksum  boolean  default: true
Gets or sets whether checksum value must be displayed after the value to encode in the barcode image.
displayCode  boolean  default: true
Gets or sets whether the value to encode must be displayed in the barcode image.
displayLightMarginIndicator  boolean  default: true
Gets or sets whether light margin indicators must be displayed in the barcode image. Only available for EAN/UPC Symbologies.
displayStartStopChar  boolean  default: true
Gets or sets whether start and stop characters must be displayed in the barcode image.
dotCodeAspectRatio  string  default:   nullable: true
Gets or sets the Columns (width) to Rows (height) Aspect Ratio for DotCode symbology. Aspect Ratio must be specified as C:R where C and R are integers e.g. 3:2
dotCodeColumns  integer ($int32)  default: 0
Gets or sets the number of columns to use for DotCode symbology.
dotCodeModuleShape  string  default: Circle
Gets or sets the shape of the modules that make the DotCode barcode symbol.

Enum
[ Circle, Square ]
dotCodeModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
dotCodeProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when DotCode is being generated.
dotCodeRows  integer ($int32)  default: 0
Gets or sets the number of rows to use for DotCode symbology.
eanUpcAutoBWAfor1278DigitsEnabled  boolean  default: false
Gets or sets whether the recommended Bar Width Adjustment for digits 1, 2, 7 and 8 by GS1 spec is enabled. The GS1 spec states that for digits 1, 2, 7 or 8; the bars (dark bars) and spaces (light bars) are reduced or enlarged by one-thirteenth of a module (BarWidth) to provide a uniform distribution of bar width tolerances and thus improve scanning reliability.
eanUpcMagnificationFactor  number ($float)  default: 0
Gets or sets the Magnification Factor for EAN/UPC barcodes. EAN/UPC barcodes can be printed at various densities to accommodate a variety of printing and scanning processes. The significant dimensional parameter is X, the ideal width of a single module element. In Barcode Professional, this is specified with barWidth property. For EAN/UPC symbols, the X-dimension at nominal size is 0.33 millimeter (= 0.013 inch). The "magnification factor" specifies the size of the barcode symbol as a whole by taking the nominal size as the 1.0 (100%) value.
eanUpcSupplement  string  default: None
Gets or sets the supplement type to use with EAN and UPC symbologies.

Enum
[ None, Digits2, Digits5 ]
eanUpcSupplementCode  string  default: 00000  nullable: true
Gets or sets the supplement value for EAN and UPC symbologies.
eanUpcSupplementSeparation  number ($double)  default: 0.15
Gets or sets the gap separation between the EAN/UPC barcode and its supplement. The unit of measure must be specified to barcodeUnit property.
eanUpcSupplementTopMargin  number ($double)  default: 0.15
Gets or sets the height of the margin above the EAN/UPC supplement bars. The unit of measure must be specified to barcodeUnit property.
fitProportional  boolean  default: false
Gets or sets whether the barcode symbol is created by automatically calculating the bars or modules sizes so it fits the available area (Width - Height) proportinaly.
fontBold  boolean  default: false
Gets or sets whether the Font object for code and humanReadableText properties must be bold.
fontItalic  boolean  default: false
Gets or sets whether the Font object for code and humanReadableText properties must be italic.
fontName  string  default: Arial  nullable: true
Gets or sets the Font name for using when rendering code and humanReadableText properties.
fontSizeInPoints  number ($float)  default: 8
Gets or sets the Font size in points unit (1/72 inch) when rendering code and humanReadableText properties.
fontStrikeout  boolean  default: false
Gets or sets whether the Font object for code and humanReadableText properties specifies a horizontal line through it.
fontUnderline  boolean  default: false
Gets or sets whether the Font object for code and humanReadableText properties is underlined.
foreColor  string  default: #000  nullable: true
Gets or sets the text color for using when rendering code and humanReadableText properties.
gS1DataStrictValidation  boolean  default: false
Gets or sets whether to strictly validate the specified GS1 Element Strings i.e. Application Identifier plus Data Field based on GS1 General Specifications rules.
guardBar  boolean  default: true
Gets or sets whether EAN/UPC guard bars must be drawn.
guardBarHeight  number ($double)  default: 1.1
Gets or sets the guard bars' height. The unit of measure must be specified to barcodeUnit property.
hanXinCodeByteEncodingName  string  default: ISO-8859-1  nullable: true
Gets or sets the Encoding Name (Code Page) to be used for Han Xin Code Binary Byte Encoding mode.
hanXinCodeEncoding  string  default: Auto
Gets or sets the Han Xin Code Encoding to use on that symbology.

Enum
[ Auto, Numeric, Text, BinaryByte, ChineseReg1, ChineseReg2, GB18030Bytes2, GB18030Bytes4 ]
hanXinCodeErrorCorrectionLevel  string  default: L1
Gets or sets the Error Correction Level to apply for Han Xin Code symbology.

Enum
[ L1, L2, L3, L4 ]
hanXinCodeModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
hanXinCodeProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when Han Xin Code is being generated.
hanXinCodeVersion  string  default: Auto
Gets or sets the Han Xin Code Version to use on that symbology.

Enum
[ Auto, V01, V02, V03, V04, V05, V06, V07, V08, V09, V10, V11, V12, V13, V14, V15, V16, V17, V18, V19, V20, V21, V22, V23, V24, V25, V26, V27, V28, V29, V30, V31, V32, V33, V34, V35, V36, V37, V38, V39, V40, V41, V42, V43, V44, V45, V46, V47, V48, V49, V50, V51, V52, V53, V54, V55, V56, V57, V58, V59, V60, V61, V62, V63, V64, V65, V66, V67, V68, V69, V70, V71, V72, V73, V74, V75, V76, V77, V78, V79, V80, V81, V82, V83, V84 ]
hibcFormatHumanReadableText  boolean  default: true
Gets or sets whether the Human Readable Text is formatted as specified by HIBC Standards i.e. Zeros are displayed as Slashed-Zeros and the Space character is displayed as an Underscore.
hibcUseIsoIec15434Encoding  boolean  default: false
Gets or sets whether the ISO/IEC 15434 Protocol is used to encode the HIBC LIC or PAS Data Structures in 2D symbols.
humanReadableText  string  default:   nullable: true
Gets or sets the Human Readable Text to be displayed instead of the value to encode specified in the code property.
isbt128DataStructure  string  default: DS001
Gets or sets the ISBT 128 Data Structure to be generated.

Enum
[ DS001, DS002, DS003, DS004, DS005, DS006, DS007, DS008, DS009, DS010, DS011, DS012, DS013, DS014, DS015, DS016, DS017, DS018, DS019, DS020, DS021, DS022, DS023, DS024, DS025, DS026, DS027, DS028, DS029, DS030, DS031, DS032, DS033, DS034 ]
itf14LeftHMark  string  default: None
Gets or sets the H mark type for the left side of ITF-14 barcode symbol.

Enum
[ None, Mark1, Mark2, Mark3, Mark4, Mark5, Mark6, Mark7 ]
itf14RightHMark  string  default: None
Gets or sets the H mark type for the right side of ITF-14 barcode symbol.

Enum
[ None, Mark1, Mark2, Mark3, Mark4, Mark5, Mark6, Mark7 ]
jabCodeColors  integer ($int32)  default: 8
Gets or sets the number of colors for JAB Code Symbol. The number of colors can be set to 2, 4, 8, 16, 32, 64, 128, or 256.
jabCodeModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
jabCodeSymbolCount  integer ($int32)  default: 1
Gets or sets the number of JAB Code Symbols to generate. JAB Code can be composed of a master symbol and many slave symbols. 61 is the maximum number of symbols.
jabCodeSymbolEccLevel  string  default:   nullable: true
Gets or sets the Error Correction Code Level for each or all of the JAB Code Symbols. Default is an empty string which specifies an ECC Level 5. The Error Correction Code levels range from 0 up to 10. If each JAB Code Symbol (in a master-slaves scenario) requires different ECC Levels, then it must be specified in a comma separated string. E.g. 8,4,5 means ECC Level 8 for master symbol and ECC Level 4 and 5 for first and second slave symbols respectively.
jabCodeSymbolPosition  string  default:   nullable: true
Gets or sets the position for each or all of the JAB Code Symbols. Default is an empty string which specifies position 0 (center). JAB Code may have arbitrary forms by cascading master and slave symbols in horizontal and vertical directions. JAB Slave symbols can be docked to the side of a master symbol or other slave symbols. In a master-slaves scenario, each JAB Code Symbol position or location must be specified in a comma separated string stating the Position Indexes (Refer to https://neodynamic.com/barcodes JAB Code page to learn more about Position Indexes). E.g. 0,3,2 means Position Index 0 for master symbol and Position Index 3 and Position Index 2 for first and second slave symbols respectively.
jabCodeSymbolVersion  string  default:   nullable: true
Gets or sets the Version (Side size) for each or all of the JAB Code Symbols. Default is an empty string which specifies the minimum size. A JAB Code Symbol can be of either square or rectangle form. JAB Code allows side Versions ranging from Version 1 (25 modules) up to Version 32 (145 modules). To specify a given side Version, a string must be specified in the format WxH where W is the horizonal side Version number and H is the vertical side Version Number. E.g. 4x4 would be a square JAB Symbol Version 4, 4x2 would be a rectangular JAB Symbol Version 4 (horizontal) and Version 2 (vertical). In a master-slaves scenario, if each JAB Code Symbol requires different side Versions, then it must be specified in a comma separated string. E.g. 4x4,4x2 means Version 8 for master symbol and Version 4 by Version 2 for the slave symbol.
maxiCodeDrawPixelBasedSymbol  boolean  default: false
Gets or sets whether the MaxiCode symbol is drawn by using a Pixel Based method; otherwise, a Vector based method is used.
maxiCodeMode  string  default: Mode3
Gets or sets the MaxiCode mode.

Enum
[ Mode2, Mode3, Mode4, Mode5, Mode6 ]
maxiCodeProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when MaxiCode code is being generated.
maxiCodeSymbolCount  integer ($int32)  default: 1
Gets or sets the number of MaxiCode symbols in a Structured Appended format. Its value must be less than or equal to 8.
maxiCodeSymbolIndex  integer ($int32)  default: 1
Gets or sets the Symbol Index for a Structured Appended MaxiCode. Its value must be 1 up to 8 and must be less than the value in maxiCodeSymbolCount property.
microPdf417Version  string  default: Auto
Gets or sets the MicroPDF417 version (a predefined combinations of numbers of columns and rows) to be generated.

Enum
[ Auto, V1X11, V1X14, V1X17, V1X20, V1X24, V1X28, V2X8, V2X11, V2X14, V2X17, V2X20, V2X23, V2X26, V3X6, V3X8, V3X10, V3X12, V3X15, V3X20, V3X26, V3X32, V3X38, V3X44, V4X4, V4X6, V4X8, V4X10, V4X12, V4X15, V4X20, V4X26, V4X32, V4X38, V4X44 ]
microQRCodeVersion  string  default: Auto
Gets or sets the Micro QR Code Version to use on that symbology.

Enum
[ Auto, M1, M2, M3, M4 ]
msiChecksum  string  default: OneMod10
Gets or sets the checksum mode to be used on MSI symbology.

Enum
[ OneMod10, TwoMod10, Mod11AndMod10 ]
pdf417AspectRatio  number ($double)  default: 0
Gets or sets the ratio of the height to the overall width of the PDF417 symbol. Its value must be 0 (zero) up to 1 (one).
pdf417ByteEncodingName  string  default: ISO-8859-1  nullable: true
Gets or sets the Encoding Name (Code Page) to be used for PDF417 Byte Compaction mode.
pdf417Columns  integer ($int32)  default: 0
Gets or sets the number of columns to use for PDF417 symbology.
pdf417CompactionType  string  default: Auto
Gets or sets the Compaction Type to apply for PDF417 symbology.

Enum
[ Auto, Binary, Text, Numeric ]
pdf417ErrorCorrectionLevel  string  default: Level2
Gets or sets the Error Correction Level to apply for PDF417 symbology.

Enum
[ Level0, Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8 ]
pdf417FileId  string  default: 000  nullable: true
Gets or sets the File ID of the Macro PDF417 symbol. Its value must be a sequence of codewords (Each codeword value must be a number between 000 and 899) and must be the same for all data segments.
pdf417Rows  integer ($int32)  default: 0
Gets or sets the number of rows to use for PDF417 symbology.
pdf417SegmentCount  integer ($int32)  default: 0
Gets or sets the number of Macro PDF417 symbols. Its value must be less than or equal to 99999.
pdf417SegmentIndex  integer ($int32)  default: 0
Gets or sets the Segment Index for a Macro PDF417 symbol. Its value must be 0 (zero) up to 99998 and must be less than the value in pdf417SegmentCount property.
pdf417Truncated  boolean  default: false
Gets or sets whether the right side of PDF417 barcode is truncated (removed).
pharmacode2DColorField1  string  default: #5E9C3E  nullable: true
Gets or sets the Pharmacode 2D Color Field 1 in hex notation. Default is #5E9C3E (RGB 94, 156, 62).
pharmacode2DColorField2  string  default: #B84027  nullable: true
Gets or sets the Pharmacode 2D Color Field 2 in hex notation. Default is #B84027 (RGB 184, 64, 39).
pharmacode2DColorField3  string  default: #497AC3  nullable: true
Gets or sets the Pharmacode 2D Color Field 3 in hex notation. Default is #497AC3 (RGB 73, 122, 195).
pharmacode2DColorField4  string  default: #F0EB04  nullable: true
Gets or sets the Pharmacode 2D Color Field 4 in hex notation. Default is #F0EB04 (RGB 240, 235, 4).
pharmacode2DColorField5  string  default: #282374  nullable: true
Gets or sets the Pharmacode 2D Color Field 5 in hex notation. Default is #282374 (RGB 40, 35, 116).
pharmacode2DColorField6  string  default: #98C2A1  nullable: true
Gets or sets the Pharmacode 2D Color Field 6 in hex notation. Default is #98C2A1 (RGB 152, 194, 161).
pharmacode2DColorField7  string  default: #CB801C  nullable: true
Gets or sets the Pharmacode 2D Color Field 7 in hex notation. Default is #CB801C (RGB 203, 128, 28).
pharmacode2DColorField8  string  default: #7A2E78  nullable: true
Gets or sets the Pharmacode 2D Color Field 8 in hex notation. Default is #7A2E78 (RGB 122, 46, 120).
pharmacode2DColorFields  string  default: Standard
Gets or sets the 2D-Pharmacode Color Fields type.

Enum
[ None, Standard, ExtraColorsVariantA, ExtraColorsVariantB ]
pharmacode2DTriggerMark  string  default: Left
Gets or sets whether to display the 2D-Pharmacode Trigger Mark and its location.

Enum
[ None, Left, Right, Top, Bottom ]
pharmacodeBarsSpacing  number ($double)  default: 0.0417
Gets or sets the gap between Pharmacode bars. The unit of measure must be specified to barcodeUnit property.
pharmacodeThickBarWidth  number ($double)  default: 0.0625
Gets or sets the width of Pharmacode Thick Bars. The unit of measure must be specified to barcodeUnit property.
pharmacodeThinBarWidth  number ($double)  default: 0.0208
Gets or sets the width of Pharmacode Thin Bars. The unit of measure must be specified to barcodeUnit property.
planetHeightShortBar  number ($double)  default: 0.1
Gets or sets the short bars' height of Planet symbology. The unit of measure must be specified to barcodeUnit property.
planetHeightTallBar  number ($double)  default: 0.2
Gets or sets the tall bars' height of Planet symbology. The unit of measure must be specified to barcodeUnit property.
postal4StateAddStartStopChar  boolean  default: true
Gets or sets whether start and stop characters must be added and drawn in the barcode image.
postal4StateBarsSpacing  number ($double)  default: 0.0313
Gets or sets the gap spacing between bars. The unit of measure must be specified to barcodeUnit property.
postal4StateTrackerBarHeight  number ($double)  default: 0.08
Gets or sets the tracker bar's height. The unit of measure must be specified to barcodeUnit property.
postal4StateTrackerBarWidth  number ($double)  default: 0.0208
Gets or sets the tracker bar's width. The unit of measure must be specified to barcodeUnit property.
postnetHeightShortBar  number ($double)  default: 0.1
Gets or sets the short bars' height of Postnet symbology. The unit of measure must be specified to barcodeUnit property.
postnetHeightTallBar  number ($double)  default: 0.2
Gets or sets the tall bars' height of Postnet symbology. The unit of measure must be specified to barcodeUnit property.
qrCodeByteEncodingName  string  default: ISO-8859-1  nullable: true
Gets or sets the Encoding Name (Code Page) to be used for QR Code Byte Compaction mode. Default it ISO-8859-1.
qrCodeEncoding  string  default: Auto
Gets or sets the QR Code Encoding to use on that symbology.

Enum
[ Auto, Numeric, AlphaNumeric, Kanji, Byte ]
qrCodeErrorCorrectionLevel  string  default: M
Gets or sets the Error Correction Level to apply for QR Code symbology.

Enum
[ L, M, Q, H ]
qrCodeModuleSize  number ($double)  default: 0.0417
Gets or sets the module size. The unit of measure must be specified to barcodeUnit property.
qrCodeProcessTilde  boolean  default: false
Gets or sets whether tilde character should be processed when QR Code is being generated.
qrCodeVersion  string  default: Auto
Gets or sets the QR Code Version to use on that symbology.

Enum
[ Auto, V01, V02, V03, V04, V05, V06, V07, V08, V09, V10, V11, V12, V13, V14, V15, V16, V17, V18, V19, V20, V21, V22, V23, V24, V25, V26, V27, V28, V29, V30, V31, V32, V33, V34, V35, V36, V37, V38, V39, V40 ]
quietZoneWidth  number ($double)  default: 0.1
Gets or sets the quiet zone's width. The unit of measure must be specified to barcodeUnit property.
rotate  string  default: None
Gets or sets the rotation angle to apply on the barcode image.

Enum
[ None, Degree90, Degree180, Degree270 ]
segmentsPerRow  integer ($int32)  default: 4
Gets or sets the number of segments per row to be used in GS1 DataBar Expanded Stacked or RSS Expanded Stacked symbologies. It must be an even number ranging from 2 up to 22.
snapsToDevicePixels  boolean  default: false
Gets or sets a value that determines whether barcode drawing should use device-specific pixel settings during rendering.
telepenEncoding  string  default: Ascii
Gets or sets the Telepen Encoding to use on that symbology.

Enum
[ Ascii, Numeric ]
text  string  default:   nullable: true
Gets or sets the additional text to show in the barcode image e.g.: Product ID. Note: This is not the value to encode nor the Human Readable Text.
textAlignment  string  default: AboveCenter
Gets or sets the text alignment for text property.

Enum
[ AboveCenter, AboveLeft, AboveRight, AboveJustify, BelowCenter, BelowLeft, BelowRight, BelowJustify ]
textFontBold  boolean  default: false
Gets or sets whether the Font object for text property must be bold.
textFontItalic  boolean  default: false
Gets or sets whether the Font object for text property must be italic.
textFontName  string  default: Arial  nullable: true
Gets or sets the Font name for using when rendering text property.
textFontSizeInPoints  number ($float)  default: 8
Gets or sets the Font size in points unit (1/72 inch) when rendering text property.
textFontStrikeout  boolean  default: false
Gets or sets whether the Font object for text property specifies a horizontal line through it.
textFontUnderline  boolean  default: false
Gets or sets whether the Font object for text property is underlined.
textForeColor  string  default: #000  nullable: true
Gets or sets the text color for using when rendering text property.
textFormatPattern  string  default:   nullable: true
Gets or sets the string pattern to format the text property.
tlc39MicroPdf417BarWidth  number ($double)  default: 0.0104
Gets or sets the narrow bar width for TLC39's MicroPdf417 symbol. The unit of measure must be specified to barcodeUnit property.
tlc39MicroPdf417RowBarHeight  number ($double)  default: 0.03125
Gets or sets the row bar height for TLC39's MicroPdf417 symbol. The unit of measure must be specified to barcodeUnit property.
topMargin  number ($double)  default: 0
Gets or sets the height of the margin above the barcode bars. The unit of measure must be specified to barcodeUnit property.
upcESystem  string  default: System0
Gets or sets the number system to use for UPC-E symbology.

Enum
[ System0, System1 ]
useQuietZoneForText  boolean  default: false
Gets or sets whether quiet zones are used for drawing text, code and humanReadableText properties.
uspsFimPattern  string  default: A
Gets or sets the USPS FIM pattern to use on that symbology.

Enum
[ A, B, C, D ]
uspsHorizontalBarsCount  integer ($int32)  default: 10
Gets or sets the number of horizontal bars to be drawn.

The Accept Header

The desired output rendering format must be specified through the Accept header. The supported formats are the following:

Accept Description
image/png Returns the generated barcode symbol in PNG format.
image/jpeg Returns the generated barcode symbol in JPEG/JPG format.
application/pdf Returns generated barcode symbol as a single PDF document.
application/postscript Returns generated barcode symbol in EPS format. Requires a license key...
image/svg+xml Returns generated barcode symbol in SVG format. Requires a license key...
image/vnd.zbrush.pcx Returns the generated barcode symbol in PCX format.

Errors

Conventional HTTP response codes will indicate the success or failure of an API request. Upon an error, the BarcodePro Web API will return one of the following 'error' responses.

HTTP Status Code Content-type Description
500
applications/json ProblemDetails Object
{
  "type": "string",
  "title": "string",
  "status": 500,
  "detail": "string",
  "traceId": "string"
}
An unexpected error occurred in our code while processing the specified BarcodeProJob. Please contact our support if you encounter this error.

Licensing

On-Premise - Full Deployment Control

BarcodePro Web API is licensed for Private On-Premise environments giving you full control on the infrastructure where our product will run on. Please refer to Licensing model and prices...

 License Registration

When you buy a commercial license of BarcodePro Web API for Docker, you are provided with license information (LicenseOwner & LicenseKey) to register the product. The license information must be specified to the Docker image as environment variables as folows:

docker run -it --rm -e "LICENSE_OWNER=YOUR-COMPANY-NAME" -e "LICENSE_KEY=YOUR_KEY" -p 8080:80 neodynamic/barcodeprowebapi:1.0.1

 Evaluation Mode

The Trial Version of BarcodePro Web API for Docker is fully functional and has no expiry date. However, while in TRIAL mode, the output rendering has the following limitations:


  • SVG & EPS barcode image formats require a license key, a blank image will be generated in TRIAL mode.
  • A TRIAL stamp will be rendered at the top of the rendering output.

 Want to try BarcodePro Web API for Docker without TRIAL watermark?

We offer you a 30-day Evaluation License Key which will allow you to test the BarcodePro Web API for Docker in fully-functional mode for 30 days! When the 30-day Evaluation License Key expires, the BarcodePro Web API for Docker behavior backs to Trial mode. Request your 30-day Evaluation License Key now...

 Change Log