HTML
 Embed barcode images directly in an HTML page:

<img src="https://barcodeapi.org/api/auto/test" />
					

JavaScript
 Use fetch to request a barcode and display it on the current page, while printing the remaining token count to the console:

let url = 'https://barcodeapi.org/api/auto/Try%20Me'
fetch(url, { cache: "no-store" })
  .then(response => {

    var tokens = response.headers.get('X-RateLimit-Tokens');
    console.log("Tokens remaining: " + tokens);

    response.blob().then(blob => {
      var img = document.createElement("img");
      img.src = URL.createObjectURL(blob);
      document.body.appendChild(img);
    });
});
					

Excel
 Render barcode images directly into Excel, referencing data which exists in the document:

Using:	https://barcodeapi.org/api/
Config:	fg=ff0000&bg=0000ff
Barcode Text	Type
TryMe	128	=IMAGE(B1&B4&"/"&A4&"?"&B2)
TryMe	qr	=IMAGE(B1&B5&"/"&A5&"?"&B2)
TryMe	dm	=IMAGE(B1&B6&"/"&A6&"?"&B2)

=IMAGE("https://barcodeapi.org/api/TryMe")
					

Markdown
 Add barcode images to markdown documents:

![BarcodeAPI Image](https://barcodeapi.org/api/auto/test)
					

curl / wget
 Download barcodes in a linux command line environment:

curl https://barcodeapi.org/api/A_Barcode > test.png
wget -o test.png https://barcodeapi.org/api/A_Barcode
					

PowerShell
 Generate barcodes using Windows PowerShell automation:

Invoke-WebRequest `
  https://barcodeapi.org/api/auto/test -OutFile test.png
					

Python
 Request and save a barcode to disk using Python:

import shutil
import requests

url = 'https://barcodeapi.org/api/auto/Try%20Me'
response = requests.get(url, stream=True)
with open('test.png', 'wb') as out_file:
  shutil.copyfileobj(response.raw, out_file)
					

Barcode Information

  The server will add several headers related to the barcode including the type and encoded contents.

$ curl --head https://barcodeapi.org/api/auto/abc123
...
Content-Type: image/png
X-Barcode-Type: Code128
X-Barcode-Content: abc123
Content-Disposition: filename=abc123.png
					

Cache Control

  In an attempt to minimize the number of requests, barcodes requested outside of the webapp will have a cache expiration time set.

$ curl --head https://barcodeapi.org/api/auto/abc123
...
Access-Control-Max-Age: 86400
Cache-Control: max-age=86400, public
Expires: Sat, 04 Jan 2025 06:57:14 GMT
					

Rate Limits

  The server will add several headers related to the rate limiter applied to the client.

$ curl --head https://barcodeapi.org/api/auto/abc123
...
X-RateLimit-Cost: 2
X-RateLimit-Tokens: 2032.40
					

  Should a client become rate limited, requests to the server will result in a 429 error code indicating their rate limit is enforced. The caller must wait until new tokens are generated before additional requests will be served.

$ curl --head https://barcodeapi.org/api/auto/abc123
HTTP/1.1 429 Too Many Requests
...
X-Error-Message: Client is rate limited, try again later.
					

API Redirect

  The server provides a set of static resources served from the root url of the server, in the event a request is made which is not targeted directly at the API nor references a known resources, a 403 redirect will be provided to send the send request to the API handler.

$ curl --head https://barcodeapi.org/abc123
HTTP/1.1 302 Found
...
Location: https://barcodeapi.org/api/auto/abc123
					

Generation Errors

  Each type of barcode generation failure will result in a unique HTTP status code.

200	OKAY		Barcode generated sucessfully.
400	INVALID		Invalid data for selected code type.
403	ABUSE		The IP is blocked for abuse.
406	EMPTY		The request was empty.
409	CHECKSUM	Expected checksum: #
412	BLACKLIST	The request was rejected.
429	LIMITED		Client is rate limited, try again later.
500	FAILED		Failed to render barcode.
503	BUSY		Server is busy, please try again.
					

  In the event of a render error, an additional header [X-Error-Message] will be available containing details about the exception.

$ curl --head https://barcodeapi.org/api/8/00000009
HTTP/1.1 409 Conflict
...
X-Error-Message: Expected checksum: 0