Barcode REST API

The ActiveBarcode API creates PNG and JPG images to allow a wide range of applications. Best practise is to use PNG because this format creates compact and loseless images and is therefore a perfect match for barcodes.

PNG

https://api.activebarcode.net/v1/png

JPG

https://api.activebarcode.net/v1/jpg

access= You can try out and evaluate the REST API by omitting the API key. Without the access key, the barcode will be branded with a notice: "For evaluation use only". Use your API key that you received with your order confirmation instead of the placeholder. Convenient: The API key does not change as long as you do not terminate the monthly subscription. api.activebarcode.net/v1/png?access=YOUR-KEY-HERE

text= Sets the text that you want to display as a barcode. This may be an article number or a text message like "Hello World!". Make sure this parameter is URL-Encoded. You can enter control codes in human readable form like this: <CR>, <LF>, ... api.activebarcode.net/v1/png?text=ActiveBarcode&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?text=Hello%20World!&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?text=Hello<CR>World!&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?text=Hello<TAB>World!&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?text=(10)451214<FNC1>(37)20&typeno=108&access=YOUR-KEY-HERE

showtext= Select whether the human readable line is visible or not. (1=visible, 0=invisible). api.activebarcode.net/v1/png?showtext=1&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?showtext=0&access=YOUR-KEY-HERE

typeno= Barcode type as number that you want to use for encoding i.e.: 14 (=CODE128) api.activebarcode.net/v1/png?typeno=14&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?typeno=42&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?typeno=113&access=YOUR-KEY-HERE Value Code Name 0 ISBN-10 CODEISBN 1 EAN 13 CODEEAN13 2 EAN 8 CODEEAN8 3 EAN 5 CODEEAN5 4 EAN 2 CODEEAN2 5 UPC A CODEUPCA 6 Code 39 CODE39 7 Code 25 Interleaved CODE25I 8 Codabar CODABAR 9 Code 25 Industrial CODE25 10 Code 39 Extended CODE39E 11 Code 128A CODECODE128A 12 Code 128B CODECODE128B 13 Code 128C CODECODE128C 14 Code 128 CODECODE128 15 EAN/UCC 128 CODEEAN128 16 EAN 99 CODEEAN99 17 UPC E CODEUPCE 18 PostNet CODEPOSTNET 19 Royal Mail CODEROYALMAIL 20 MSI CODEMSI 21 Code 93 CODE93 22 Code 93 Extended CODE93E 23 PZN7 CODEPZN8 24 Identcode CODEIDENTCODE 25 Leitcode CODELEITCODE 26 Code 39 Checksum CODE39CHECKSUM 27 Code 39 Extended Checksum CODE39ECHECKSUM 28 EAN/UCC 128 AI CODEEAN128AI 29 EAN 14 CODEEAN14 30 ITF-14 CODEITF14 31 EAN-18/NVE CODEEAN18 32 SSCC-18 CODESSCC18 33 Codabar Checksum CODABARCHECKSUM 34 Code 25 Interleaved Checksum CODE25ICHECKSUM 35 Code 25 Industrial Checksum CODE25CHECKSUM 36 PDF417 CODEPDF417 37 DataMatrix CODEDATAMATRIX 38 ISBN-13 CODEISBN13 39 ISBN-13 Dual CODEISBN13DUAL 40 ISSN CODEISSN 41 ISMN CODEISMN 42 DataMatrix Square CODEDATAMATRIXSQUARE 43 DataMatrix Rectangular CODEDATAMATRIXRECTANGULAR 44 DataMatrix 10x10 CODEDATAMATRIX10X10 45 DataMatrix 12x12 CODEDATAMATRIX12X12 46 DataMatrix 8x18 CODEDATAMATRIX8X18 47 DataMatrix 14x14 CODEDATAMATRIX14X14 48 DataMatrix 8x32 CODEDATAMATRIX8X32 49 DataMatrix 16x16 CODEDATAMATRIX16X16 50 DataMatrix 12x26 CODEDATAMATRIX12X26 51 DataMatrix 18x18 CODEDATAMATRIX18X18 52 DataMatrix 20x20 CODEDATAMATRIX20X20 53 DataMatrix 12x36 CODEDATAMATRIX12X36 54 DataMatrix 22x22 CODEDATAMATRIX22X22 55 DataMatrix 16x36 CODEDATAMATRIX16X36 56 DataMatrix 24x24 CODEDATAMATRIX24X24 57 DataMatrix 26x26 CODEDATAMATRIX26X26 58 DataMatrix 16x48 CODEDATAMATRIX16X48 59 DataMatrix 32x32 CODEDATAMATRIX32X32 60 DataMatrix 36x36 CODEDATAMATRIX36X36 61 DataMatrix 40x40 CODEDATAMATRIX40X40 62 DataMatrix 44x44 CODEDATAMATRIX44X44 63 DataMatrix 48x48 CODEDATAMATRIX48X48 64 DataMatrix 52x52 CODEDATAMATRIX52X52 65 DataMatrix 64x64 CODEDATAMATRIX64X64 66 DataMatrix 72x72 CODEDATAMATRIX72X72 67 DataMatrix 80x80 CODEDATAMATRIX80X80 68 DataMatrix 88x88 CODEDATAMATRIX88X88 69 DataMatrix 96x96 CODEDATAMATRIX96X96 70 DataMatrix 104x104 CODEDATAMATRIX104X104 71 DataMatrix 120x120 CODEDATAMATRIX120X120 72 DataMatrix 132x132 CODEDATAMATRIX132X132 73 DataMatrix 144x144 CODEDATAMATRIX144X144 74 GS1-Data Matrix CODEGS1DATAMATRIX 75 GS1-Data Matrix Square CODEGS1DATAMATRIXSQUARE 76 GS1-Data Matrix Rectangular CODEGS1DATAMATRIXRECTANGULAR 77 GS1-Data Matrix 10x10 CODEGS1DATAMATRIX10X10 78 GS1-Data Matrix 12x12 CODEGS1DATAMATRIX12X12 79 GS1-Data Matrix 8x18 CODEGS1DATAMATRIX8X18 80 GS1-Data Matrix 14x14 CODEGS1DATAMATRIX14X14 81 GS1-Data Matrix 8x32 CODEGS1DATAMATRIX8X32 82 GS1-Data Matrix 16x16 CODEGS1DATAMATRIX16X16 83 GS1-Data Matrix 12x26 CODEGS1DATAMATRIX12X26 84 GS1-Data Matrix 18x18 CODEGS1DATAMATRIX18X18 85 GS1-Data Matrix 20x20 CODEGS1DATAMATRIX20X20 86 GS1-Data Matrix 12x36 CODEGS1DATAMATRIX12X36 87 GS1-Data Matrix 22x22 CODEGS1DATAMATRIX22X22 88 GS1-Data Matrix 16x36 CODEGS1DATAMATRIX16X36 89 GS1-Data Matrix 24x24 CODEGS1DATAMATRIX24X24 90 GS1-Data Matrix 26x26 CODEGS1DATAMATRIX26X26 91 GS1-Data Matrix 16x48 CODEGS1DATAMATRIX16X48 92 GS1-Data Matrix 32x32 CODEGS1DATAMATRIX32X32 93 GS1-Data Matrix 36x36 CODEGS1DATAMATRIX36X36 94 GS1-Data Matrix 40x40 CODEGS1DATAMATRIX40X40 95 GS1-Data Matrix 44x44 CODEGS1DATAMATRIX44X44 96 GS1-Data Matrix 48x48 CODEGS1DATAMATRIX48X48 97 GS1-Data Matrix 52x52 CODEGS1DATAMATRIX52X52 98 GS1-Data Matrix 64x64 CODEGS1DATAMATRIX64X64 99 None CODENONE 100 GS1-Data Matrix 72x72 CODEGS1DATAMATRIX72X72 101 GS1-Data Matrix 80x80 CODEGS1DATAMATRIX80X80 102 GS1-Data Matrix 88x88 CODEGS1DATAMATRIX88X88 103 GS1-Data Matrix 96x96 CODEGS1DATAMATRIX96X96 104 GS1-Data Matrix 104x104 CODEGS1DATAMATRIX104X104 105 GS1-Data Matrix 120x120 CODEGS1DATAMATRIX120X120 106 GS1-Data Matrix 132x132 CODEGS1DATAMATRIX132X132 107 GS1-Data Matrix 144x144 CODEGS1DATAMATRIX144X144 108 GS1-128 CODEGS1128 109 GTIN-8 CODEGTIN8 110 GTIN-12 CODEGTIN12 111 GTIN-13 CODEGTIN13 112 GTIN-14 CODEGTIN14 113 QR Code CODEQRCODE 114 QR Code ECC Level L CODEQRCODEECCLEVELL 115 QR Code ECC Level M CODEQRCODEECCLEVELM 116 QR Code ECC Level Q CODEQRCODEECCLEVELQ 117 QR Code ECC Level H CODEQRCODEECCLEVELH 118 QR Code 21x21 CODEQRCODE21X21 119 QR Code 25x25 CODEQRCODE25X25 120 QR Code 29x29 CODEQRCODE29X29 121 QR Code 33x33 CODEQRCODE33X33 122 QR Code 37x37 CODEQRCODE37X37 123 QR Code 41x41 CODEQRCODE41X41 124 QR Code 45x45 CODEQRCODE45X45 125 QR Code 49x49 CODEQRCODE49X49 126 QR Code 53x53 CODEQRCODE53X53 127 QR Code 57x57 CODEQRCODE57X57 128 QR Code 61x61 CODEQRCODE61X61 129 QR Code 65x65 CODEQRCODE65X65 130 QR Code 69x69 CODEQRCODE69X69 131 QR Code 73x73 CODEQRCODE73X73 132 QR Code 77x77 CODEQRCODE77X77 133 QR Code 81x81 CODEQRCODE81X81 134 QR Code 85x85 CODEQRCODE85X85 135 QR Code 89x89 CODEQRCODE89X89 136 QR Code 93x93 CODEQRCODE93X93 137 QR Code 97x97 CODEQRCODE97X97 138 QR Code 101x101 CODEQRCODE101X101 139 QR Code 105x105 CODEQRCODE105X105 140 QR Code 109x109 CODEQRCODE109X109 141 QR Code 113x113 CODEQRCODE113X113 142 QR Code 117x117 CODEQRCODE117X117 143 QR Code 121x121 CODEQRCODE121X121 144 QR Code 125x125 CODEQRCODE125X125 145 QR Code 129x129 CODEQRCODE129X129 146 QR Code 133x133 CODEQRCODE133X133 147 QR Code 137x137 CODEQRCODE137X137 148 QR Code 141x141 CODEQRCODE141X141 149 QR Code 145x145 CODEQRCODE145X145 150 QR Code 149x149 CODEQRCODE149X149 151 QR Code 153x153 CODEQRCODE153X153 152 QR Code 157x157 CODEQRCODE157X157 153 QR Code 161x161 CODEQRCODE161X161 154 QR Code 165x165 CODEQRCODE165X165 155 QR Code 169x169 CODEQRCODE169X169 156 QR Code 173x173 CODEQRCODE173X173 157 QR Code 177x177 CODEQRCODE177X177 158 PZN8 CODEPZN8 Note: If you don't know the type number you can use the parameter "code" instead.

code= Set barcode type as a human readable name that you want to use for encoding i.e.: CODE128 Note: It's better to set the parameter "typeno=" because it's unique. api.activebarcode.net/v1/png?code=CODE128&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?code=CODEDATAMATRIXSQUARE&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?code=CODEQRCODE&access=YOUR-KEY-HERE

backcolor= Background color as html color. E.g. ffffff = white, 000000 = black api.activebarcode.net/v1/png?backcolor=ff0000&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?backcolor=00ff00&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?backcolor=0000ff&access=YOUR-KEY-HERE

forecolor= Foreground color as html color. E.g. ffffff = white, 000000 = black api.activebarcode.net/v1/png?forecolor=ff0000&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?forecolor=00ff00&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?forecolor=0000ff&access=YOUR-KEY-HERE

width= Sets the width of the resulting image file. api.activebarcode.net/v1/png?width=250&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?width=600&backcolor=eeeeee&access=YOUR-KEY-HERE

height= Sets the height of the resulting image file. api.activebarcode.net/v1/png?height=100&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?height=200&backcolor=eeeeee&access=YOUR-KEY-HERE

rotate= Orientation (rotation) in degrees. Possible values: 0, 90, 180, 270 api.activebarcode.net/v1/png?rotate=0&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?rotate=90&height=200&width=150&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?rotate=180&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?rotate=270&height=200&width=150&access=YOUR-KEY-HERE

BorderWidth= Border left and right. (free space) api.activebarcode.net/v1/png?BorderWidth=0&width=360&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?BorderWidth=50&width=460&backcolor=eeeeee&access=YOUR-KEY-HERE

BorderHeight= Border top and bottom. (free space) api.activebarcode.net/v1/png?BorderHeight=0&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?BorderHeight=25&backcolor=eeeeee&access=YOUR-KEY-HERE

alignment= Alignment of the barcode within the area to be displayed: alignment=left, alignment=center, alignment=right. If the parameter is not specified, the barcode is centered. Alternatively, numerical values can be used: alignment=0 (left), alignment=1 (center), alignment=2 (right). api.activebarcode.net/v1/png?alignment=left&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?alignment=center&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?alignment=right&backcolor=eeeeee&access=YOUR-KEY-HERE

NotchHeightInPercent= Hight of the notches (EAN-13, UPC-A/E and others) in percent. api.activebarcode.net/v1/png?NotchHeightInPercent=50&code=CODEEAN13&text=123456789012&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?NotchHeightInPercent=100&code=CODEEAN13&text=123456789012&access=YOUR-KEY-HERE

fontname= Font of the barcode cleartext line. api.activebarcode.net/v1/png?fontname=Arial&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontname=Times%20New%20Roman&access=YOUR-KEY-HERE

fontsize= Font size of the barcode cleartext line. api.activebarcode.net/v1/png?fontsize=8&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontsize=28&access=YOUR-KEY-HERE

fontbold= font bold (on/off/0/1) api.activebarcode.net/v1/png?fontbold=on&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontbold=off&access=YOUR-KEY-HERE

fontitalic= font italic (on/off/0/1) api.activebarcode.net/v1/png?fontitalic=on&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontitalic=off&access=YOUR-KEY-HERE

fontunderline= font underline (on/off/0/1) api.activebarcode.net/v1/png?fontunderline=on&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontunderline=off&access=YOUR-KEY-HERE

fontstrikeout= font strikeout (on/off/0/1) api.activebarcode.net/v1/png?fontstrikeout=on&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?fontstrikeout=off&access=YOUR-KEY-HERE

ocr= Optical character recognition (on/off/0/1) Enable OCR if the text generated in the barcode image needs to be analyzed. If automatic error handling is required, this allows the input text to be compared with the resulting text in the barcode image. When using parameters with critical values, a SIZE ERROR or TEXT ERROR image may be generated instead of the desired barcode. A human will visually see these errors and act accordingly. To detect these error situations when the API is automated, these error messages can be evaluated from the image using optical character recognition. When OCR is enabled, the OCR-result field is added to the http response header. Note that checksum characters might be added to the barcode text when comparing it to the input text. Also note that the barcode image must have a plain text line with recognizable text so choose the font accordingly. If this parameter is omitted, the default is off. Enable this feature only if it's really needed, as it will add some latency to perform OCR on the requested barcode. This feature is only available if the API key is provided. api.activebarcode.net/v1/png?ocr=on&access=YOUR-KEY-HERE api.activebarcode.net/v1/png?ocr=off&access=YOUR-KEY-HERE