BarcodePro Web API for Docker

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, PCL, TIFF, SVG, EPS, and PDF!

It ships as a Linux Docker image for amd64 and arm64 that you run on your own servers, Kubernetes cluster or cloud account. If you prefer an in-process library for .NET, see Barcode Professional for .NET Standard.

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

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:

  AMD
  docker pull neodynamic/barcodeprowebapi:5.0.2
  ARM
  docker pull neodynamic/barcodeprowebapi:5.0.2-arm64

• To run the Docker image, please type the following from a Terminal:

  AMD
  docker run -it --rm -p 8080:8080 neodynamic/barcodeprowebapi:5.0.2
  ARM
  docker run -it --rm -p 8080:8080 neodynamic/barcodeprowebapi:5.0.2-arm64
   License Registration •  Evaluation Mode Limitations •  Change Log
  
  

  Special Parameters

  • Auto HTTPS Redirection: By default, HTTPS redirection is enabled. It can be disabled by specifying the following parameter -e "USE_HTTPS_REDIRECTION=false"
  • Swagger UI: By default, Swagger UI is enabled. It can be disabled by specifying the following parameter -e "SWAGGER_UI_ENABLED=false"

Run BarcodePro WebAPI on a Custom Port

By default, our Docker image exposes port 8080 only. If you want to expose and use another different port, then do the following.

1. Let's suppose you want to use port 12345, then run the docker image with the following parameters:
   
   
   AMD

   docker run -it --rm -p 8080:12345 neodynamic/barcodeprowebapi:5.0.2 -e ASPNETCORE_HTTP_PORTS=12345

   ARM

   docker run -it --rm -p 8080:12345 neodynamic/barcodeprowebapi:5.0.2-arm64 -e ASPNETCORE_HTTP_PORTS=12345
2. Special case for port 80: If you need to use port 80, then run the docker image with the following parameters:
   
   
   AMD

   docker run -it --rm -p 8080:80 neodynamic/barcodeprowebapi:5.0.2 -u root -e ASPNETCORE_HTTP_PORTS=80

   ARM

   docker run -it --rm -p 8080:80 neodynamic/barcodeprowebapi:5.0.2-arm64 -u root -e ASPNETCORE_HTTP_PORTS=80

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
•   PHP
•   RUBY
•   PYTHON
•   PERL
•   JAVA
•   C#
•   JS/XHR
•   NODE

                    
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 body = new StringEntity(json);
httpPost.setEntity(body);
httpPost.setHeader("Accept", "image/png");
httpPost.setHeader("Content-type", "application/json");
 
CloseableHttpResponse response = client.execute(httpPost);
HttpEntity result = response.getEntity();
if (result != null) {
    try (FileOutputStream outstream = new FileOutputStream(new File("label.png"))) {
        result.writeTo(outstream);
    }
}
client.close();     
                        
                

                    
using var http = new HttpClient();

string json = JsonSerializer.Serialize(new { symbology = "QRCode", code = "12345" });
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:8080/BarcodeGenerator")
{
    Content = new StringContent(json, Encoding.UTF8, "application/json")
};
request.Headers.Accept.ParseAdd("image/png");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
await File.WriteAllBytesAsync("barcode.png", await response.Content.ReadAsByteArrayAsync());
                        
                

                    
// Browser (inside a <script type="module">): show the barcode in an img element
const response = await fetch("http://localhost:8080/BarcodeGenerator", {
    method: "POST",
    headers: { "Content-Type": "application/json", "Accept": "image/png" },
    body: JSON.stringify({ symbology: "QRCode", code: "12345" })
});
const blob = await response.blob();
document.getElementById("barcode").src = URL.createObjectURL(blob);
                        
                

                    
// Node.js 18+ (built-in fetch). Save as convert.mjs (ES module, top-level await)
import fs from "fs";

const response = await fetch("http://localhost:8080/BarcodeGenerator", {
    method: "POST",
    headers: { "Content-Type": "application/json", "Accept": "image/png" },
    body: JSON.stringify({ symbology: "QRCode", code: "12345" })
});
fs.writeFileSync("barcode.png", Buffer.from(await response.arrayBuffer()));
                        
                

The Accept Header

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

The Barcode JSON Object

The body of POST /BarcodeGenerator is a Barcode JSON object. Only symbology and code are required; every other property has a sensible default. These are the most used properties:

Symbology values (194)

Valid values for the symbology property:

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, RectMicroQRCode, GS1RectMicroQRCode, DPDCode, DAFT, VINCode39, VINQRCode, VINDataMatrix, PharmacodeTwoTrack, Ultracode

Visual samples and specifications of each barcode type are in the Barcode Center.

Errors

Successful requests return HTTP 200 with the barcode in the format requested by the Accept header. Invalid data for the chosen symbology or any processing error returns HTTP 500 with a ProblemDetails JSON object:

{
  "type": "string",
  "title": "string",
  "status": 500,
  "detail": "string",
  "instance": "string"
}

Web API Doc

Interactive OpenAPI reference. The same swagger.json is used by the Swagger UI built into the container (enabled by default). All properties are also listed in The Barcode JSON Object.

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 follows:

Which Barcode Edition Do I Need?

The same GS1, ISO/IEC & AIM compliant barcode engine is available in these editions:

New web or cross-platform project? Use Barcode Professional for .NET Standard. See also the full feature comparison.

BarcodePro Web API FAQ

How do I generate a barcode with a REST API?

Run docker run -p 8080:8080 neodynamic/barcodeprowebapi:5.0.2 and POST a JSON body like {"symbology":"QRCode","code":"12345"} to http://localhost:8080/BarcodeGenerator with the Accept header set to the image format you want, for example image/png.

Which output formats are supported?

PNG, JPEG, TIFF, PCX, PCL and PDF, plus the vector formats SVG and EPS. The format is chosen with the Accept header. SVG and EPS require a license key.

Which barcode types are supported?

194 symbology values, covering linear (1D), postal, stacked, composite and 2D barcodes such as Code 128, GS1-128, EAN-13, UPC-A, ITF-14, GS1 DataBar, Data Matrix, GS1 DataMatrix, QR Code, GS1 QR Code, Micro QR, rMQR, PDF417, Aztec, MaxiCode, Han Xin, DotCode, Swiss QR Code, JAB-Code, USPS Intelligent Mail and Royal Mail Mailmark. See all symbology values.

Which programming languages can I use?

Any language that can send an HTTP POST with JSON: Python, Node.js, JavaScript, Java, PHP, C#, Ruby, Perl, Go or curl. There is no SDK to install.

Is it self-hosted?

Yes. It runs as a Docker container on your own servers, Kubernetes cluster or cloud account, so the data you encode never leaves your infrastructure.

Does it run on ARM64?

Yes. Images are published for amd64 (neodynamic/barcodeprowebapi:5.0.2) and arm64 (neodynamic/barcodeprowebapi:5.0.2-arm64).

Is there a health check endpoint?

Yes. GET /health can be used for Docker, Kubernetes or load balancer health checks.

What are the limitations of the evaluation version?

The trial is fully functional and does not expire, but it adds a TRIAL stamp to the output and SVG and EPS generate a blank image. A 30-day evaluation license key without these limitations is available on request. See Evaluation Mode.

 Latest Release: v5.0.2 2026-11-02

• Fixed! Added missing image/tiff and application/vnd.hp-pcl Accept Headers.

Full change log (all versions since v1.0) →