Parameters for the ActiveBarcode API
The ActiveBarcode API creates SVG and PNG images to allow a wide range of applications.
SVG
SVG
https://api.activebarcode.net/v2/svgPNG
https://api.activebarcode.net/v2/png
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: "DEMO". Use your API key that you received with your order confirmation instead of the placeholder. For your convenience, the API key remains unchanged as long as your monthly subscription is active. api.activebarcode.net/v2/svg?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/v2/svg?text=ActiveBarcode&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?text=Hello%20World!&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?text=Hello<CR>World!&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?text=Hello<TAB>World!&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?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/v2/svg?showtext=1&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?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/v2/svg?typeno=14&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?typeno=42&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?typeno=113&access=YOUR-KEY-HERE
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/v2/svg?code=CODE128&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?code=CODEDATAMATRIXSQUARE&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?code=CODEQRCODE&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
backcolor=Background color as html color. E.g. ffffff = white, 000000 = black api.activebarcode.net/v2/svg?backcolor=ff0000&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?backcolor=00ff00&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?backcolor=0000ff&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
forecolor=Foreground color as html color. E.g. ffffff = white, 000000 = black api.activebarcode.net/v2/svg?forecolor=ff0000&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?forecolor=00ff00&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?forecolor=0000ff&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
width=Sets the width of the resulting image file. api.activebarcode.net/v2/svg?width=250&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?width=600&backcolor=eeeeee&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
height=Sets the height of the resulting image file. api.activebarcode.net/v2/svg?height=100&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?height=200&backcolor=eeeeee&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
rotate=Orientation (rotation) in degrees. Possible values: 0, 90, 180, 270 api.activebarcode.net/v2/svg?rotate=0&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?rotate=90&height=200&width=150&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?rotate=180&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?rotate=270&height=200&width=150&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BorderWidth=Border left and right. (free space) api.activebarcode.net/v2/svg?BorderWidth=0&width=360&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?BorderWidth=50&width=460&backcolor=eeeeee&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BorderHeight=Border top and bottom. (free space) api.activebarcode.net/v2/svg?BorderHeight=0&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?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/v2/svg?alignment=left&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?alignment=center&backcolor=eeeeee&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?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/v2/svg?NotchHeightInPercent=50&code=CODEEAN13&text=123456789012&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?NotchHeightInPercent=100&code=CODEEAN13&text=123456789012&access=YOUR-KEY-HERE |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fontsize=Font size of the barcode cleartext line. api.activebarcode.net/v2/svg?fontsize=8&access=YOUR-KEY-HERE api.activebarcode.net/v2/svg?fontsize=28&access=YOUR-KEY-HERE |