API reference

Purpose

This page documents the HTTP GET interface of BE-Code in full: the base request, all optional parameters, and the complete list of supported barcode types.

Context

Every call returns a JSON object with two fields:

{
  "data": "...",
  "message": "..."
}

• data contains the barcode image as a base64-encoded PNG (with the data:image/png;base64, MIME prefix).
• message carries a status message for the request.

Prerequisites

• A BE-Code instance reachable over HTTPS.
• Basic authentication credentials. Credentials for a test instance are available from BE-terna support on request.

Base request

Every call includes at least the parameters type and content:

• type: short code of a barcode type, for example ean13, code128, or qrcode.
• content: string to encode.

Example request:

https://<fqdn>:1880/becode?content=www.be-terna.com&type=qrcode

Example response (truncated):

{
  "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAYAAABw4pVUAAAA...",
  "message": "success"
}

Optional parameters for all barcode types

• scaleX: X-axis scale, integer > 0, default 2.
• scaleY: Y-axis scale, integer > 0, default equals scaleX.
• scale: Sets both X and Y scale at once, integer > 0.
• rotate: Orthogonal rotation. Allowed values:
  • N: no rotation (default)
  • R: 90 degrees clockwise
  • L: 90 degrees counter-clockwise
  • I: 180 degrees
• padding: Shorthand for all four padding values.
• paddingwidth: Shorthand for paddingleft and paddingright.
• paddingheight: Shorthand for paddingtop and paddingbottom.
• paddingtop, paddingleft, paddingright, paddingbottom: Padding in points; rotates and scales with the image.
• backgroundcolor: Background color as a hex value (RRGGBB or CCMMYYKK).
• barcolor: Bar or module color as a hex value (RRGGBB or CCMMYYKK).
• parse: Replaces sequences such as ^NNN in content with their ASCII value. Useful for code128 or code39ext, for example ^029 for GS or ^009 for TAB.
  • true: parse content
  • false: do not parse content
• parsefnc: Enables non-data function characters via escape sequences such as ^FNC1, ^FNC2, ^FNC3, ^LNKA, ^LNKC.
  • true: parse function characters
  • false: do not parse function characters

Example request with styling:

https://<fqdn>:1880/becode?content=www.be-terna.com&type=code128&scale=1&rotate=R&paddingtop=10&paddingbottom=10&backgroundcolor=E6E6FA&barcolor=FF0000

Click to enlarge

Optional parameters for 1D barcodes

• includetext: Shows the content below the code.
  • true: show text
  • false: hide text
• textxalign: Text alignment. Allowed values: center, left, right.
• textfont: Font, default arial. Examples: CONS, ARIAL.
• textcolor: Text color as a hex value (RRGGBB or CCMMYYKK).

Example request with text:

https://<fqdn>:1880/becode?content=www.be-terna.com&type=code128&includetext=true&textxalign=center&textfont=CONS&textcolor=E6E6FA

Click to enlarge

Optional parameters for 2D barcodes

• eclevel: Error-correction level for QR codes. Allowed values:
  • L: low, up to 7 % recovery
  • M: medium, up to 15 % recovery
  • Q: quartile, up to 25 % recovery
  • H: high, up to 30 % recovery

Example request for a QR code with high error correction and colors:

https://<fqdn>:1880/becode?content=www.be-terna.com&type=qrcode&eclevel=H&backgroundcolor=E6E6FA&barcolor=FF0000

Click to enlarge

Supported barcode types

Outcome

• You can generate any supported barcode type with a single GET request.
• You control scaling, rotation, padding, colors, and optional 1D/2D parameters explicitly.
• The response embeds directly as an image.