BarCode Generation and Decoding API

Generate barcode for variety of barcode types very easily. Read and decode the contents of an existing BarCode Image.

Supported Barcode Types

Encoding

The following Barcode types are supported for barcode generation.

• C39
• C39CKSUM
• C39E
• C39ECKSUM
• C93
• S25
• S25CKSUM
• I25
• I25CKSUM
• UPCA
• UPCE
• C128
• C128A
• C128B
• C128C
• EAN2
• EAN5
• EAN8
• EAN13
• MSI
• MSICKSUM
• POSTNET
• PLANET
• RMS4CC
• KIX
• IMB
• CODABAR
• CODE11
• PHARMA
• PHARMA2T

Decoding

The following Barcode types are supported for reading.

• C39
• C39CKSUM
• C39E
• C39ECKSUM
• C93
• I25
• I25CKSUM
• C128
• C128A
• C128B
• C128C
• CODABAR

API End Points

The end point for connecting : If you subscribe directly from us use this endpoint.

	https://api.interfaces.one

API Documentation

Getting the supported types

Encoding

  GET /barcode/encode/types

Should return something like the following

{
  "success": {
    "total": 1
  },
  "contents": {
    "types": [
      "C39",
      "C39CKSUM",
      "C39E",
      "C39ECKSUM",
      "C93",
      "S25",
      "S25CKSUM",
      "I25",
      "I25CKSUM",
      "UPCA",
      "UPCE",
      "C128",
      "C128A",
      "C128B",
      "C128C",
      "EAN2",
      "EAN5",
      "EAN8",
      "EAN13",
      "MSI",
      "MSICKSUM",
      "POSTNET",
      "PLANET",
      "RMS4CC",
      "KIX",
      "IMB",
      "CODABAR",
      "CODE11",
      "PHARMA",
      "PHARMA2T"
    ]
  },
  "copyright": {
    "url": "http://interfaces.one",
    "year": "2024"
  }
}

Decoding

  GET /barcode/decode/types

Should return something like the following

{
  "success": {
    "total": 1
  },
  "contents": {
    "types": [
      "C39",
      "C39CKSUM",
      "C39E",
      "C39ECKSUM",
      "C93",
      "I25",
      "I25CKSUM",
      "C128",
      "C128A",
      "C128B",
      "C128C",
      "CODABAR"
    ]
  },
  "copyright": {
    "url": "http://interfaces.one",
    "year": "2024"
  }
}

Encoding and getting the barcode image file

GET /barcode/encode.json?code=35343355665&format=png

Should return the generated barcode image in base64 encoded format like below

{
  "success": {
    "total": 4
  },
  "contents": {
    "encoding": "base64",
    "format": "png",
    "text": "35343355665",
    "content": "data:image/png;base64,aVZCT1J3MEt..."
  },
  "copyright": {
    "url": "http://interfaces.one",
    "year": "2024"
  }
}

Ratelimiting

Some of our API calls may be public(requires free API key) , while others requires paid subscription. To maintain our serice levels both public and private API endpoints are ratelimited. Please consult your specific plan that you subscribed to for the rate limit details.

Authentication

Currently we support API Key based authentication. Please set your Autorization Bearer request header with value of your API key. Alternatively you can also pass api_key= as a request parameter, though we strongly discourage this mode of passing the key, since it will allow others to see your key.

In curl this would mean sending the Authorization header like below.

            
 curl -i <url> -H "Authorization: Bearer <api_key>"
            
            

If you are using PHP.

            
$authorization = "Authorization: Bearer <api_key>";
$ch = curl_init('<url>'); // Initialise cURL
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json' , $authorization ));
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); // OR GET
$result = curl_exec($ch);
curl_close($ch);
            
            

In javascript you can use headers key to add the authorization header

            
$.ajax({
   url: '<url>'
   type: 'GET',
   contentType: 'application/json'
   headers: {
      'Authorization': 'Bearer <api_key>'
   },
   success: function (result) {
       // CallBack(result);
   },
   error: function (error) {

   }
});