DEVELOPER DOCUMENTATION

PDF417 Generator Parameters

Everything you need to customize PDF417 barcode images with the BCMaker CGI API: parameter names, supported values, defaults, and ready-to-use GET examples.

PDF417 / API
Example of a PDF417 barcode
GET /cgi-bin/pdf417cgidHTTP / HTTPS
API OVERVIEW

One request. One barcode image.

BCMaker's PDF417 CGI generator accepts both GET and POST requests. Supply barcode data and optional settings to generate a PDF417 image.

GEThttps://www.bcmaker.com/cgi-bin/pdf417cgid
Parameters documented18
Supported methodsGET / POST
Barcode typePDF417
01 / BASICS

Image & Data

Set the encoded content and the dimensions of the resulting barcode image.

Image and Data parameters
ParameterDescriptionAccepted valuesDefault
dataContent to encode in the PDF417 symbol.Text or numeric data; pass as a URL-encoded query value.1234567
wWidth of the generated barcode image, in pixels.Image width in pixels.200
hHeight of the generated barcode image, in pixels.Image height in pixels.100
xdimX-dimension — the width of the narrowest barcode module.Used only when w and h are not specified.2
y2xRatio of the module height (Y) to its width (X).Numeric ratio, for example 4.0.4.0
02 / ENCODING

Encoding & Structure

Control compaction, error correction, symbol columns and rows, and the compact PDF417 format.

Encoding and Structure parameters
ParameterDescriptionAccepted valuesDefault
cmodeSelects the PDF417 data compaction mode.0–30
eclSets the error correction level.0–99
colSets the number of data columns.0 (automatic) through 303
rowSets the number of rows.0 (automatic), or 3–900
cpdfSelects regular or compact PDF417.0 = normal; 1 = compact1
03 / APPEARANCE

Appearance & Colors

Adjust orientation, quiet zones, alignment and colors of the generated barcode.

Appearance and Colors parameters
ParameterDescriptionAccepted valuesDefault
angleRotates the generated barcode.0, 90, 180, 270 degrees0
quietControls whether quiet zones are shown around the symbol.0 = hide; 1 = show1
alignhHorizontal alignment of the barcode within the image.0–31
alignvVertical alignment of the barcode within the image.0–31
bcolorBackground color.6-digit RGB hexadecimal, 000000–ffffff, without #ffffff
fcolorColor of the barcode modules.6-digit RGB hexadecimal, 000000–ffffff, without #000000
04 / UTILITIES

Help & Debug

Access server-provided help and troubleshooting information.

Help and Debug parameters
ParameterDescriptionAccepted valuesDefault
helpRequests help information from the PDF417 CGI application.Use help=1 to display the documentation.—
debugRequests diagnostic information about errors.Can be passed in the query string (for example, debug=1).—
EXAMPLE REQUEST

Generate a PDF417 barcode

This example encodes 1234567 and explicitly specifies the format and appearance settings used in the BCMaker demo.

PDF417 • GET
https://www.bcmaker.com/cgi-bin/pdf417cgid?data=1234567&cmode=0&ecl=9&col=3&row=0&cpdf=0&angle=0&quiet=1&alignh=1&alignv=1&bcolor=ffffff&fcolor=000000&y2x=4.0&xdim=2&w=&h=&submit=+Generate+PDF417+&debug=1
GOOD TO KNOW

Implementation Notes

01

Width, height & X-dimension

The xdim setting applies only when the image width and height are not used. Your application may omit w and h to size the barcode by its modules.

02

RGB colors

Specify bcolor and fcolor as six hexadecimal digits, without the # prefix. For example, blue is 0000ff.

03

Compact PDF417 default

The CGI help documents cpdf=1 as the server default. The BCMaker demo example explicitly sends cpdf=0 for a normal PDF417 symbol.

04

Server documentation

Parameter descriptions and default values here follow the official PDF417 CGI help. For version-specific details, use the server's own help page.

Ready to generate a barcode?

Open the BCMaker barcode types and select PDF417 to configure a request visually.

Go to Generator