QR and barcode generation on Product Documentation

Overview

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

BE-Code exposes an API that generates QR and barcode images on request. The response carries the image directly as a base64-encoded PNG, so you can embed it in documents, forms, and portals without extra steps.

Business value

Supports more than 90 barcode types for industry, logistics, healthcare, and postal services.
Returns images directly as base64-encoded PNG; a good fit for Word layouts, reports, and portals.
Offers fine-grained styling: scaling, rotation, padding, colors, human-readable text on 1D codes, and error-correction level on QR codes.
Wraps different encodings behind a single GET interface.

Functional focus

Unified HTTP GET interface

Every call returns a JSON object with two fields: data holds the image as a base64-encoded PNG, and message holds the status. You can embed barcodes server-side as easily as client-side.

API reference

Mon, 01 Jan 0001 00:00:00 +0000

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:

Example: integration with Business Central

Mon, 01 Jan 0001 00:00:00 +0000

Purpose

This example shows how BE-Code plugs into Business Central and how you can follow the execution through the BE-Code register. The example follows the shipped demo scenario for item identifiers.

Context

BE-Code runs as a middleware service. Setup is described in BE-Code setup.
When an item identifier is created or modified, the shipped event subscriber automatically inserts an entry in the BE-Code register and calls the service.

Prerequisites

The BE-Code service is available (on-premises or Azure Container Instance).
Basic authentication credentials for the service are at hand.
The BE-Code app is installed in Business Central.

Process catalog

Process Step 1 – Maintain the BE-Code setup Enter the server URL and authentication, then test the connection. +

In Business Central, open the BE-Code Setup page.
Enter the server API URL, for example https://<fqdn>:1880/becode.
Enter the basic authentication credentials.
If needed, enable the item identifier integration and maintain the API path and the default identifier parameter.
Choose the Check connection action. A success message confirms that BE-Code is reachable.

Process Step 2 – Verify execution in the BE-Code register Trace the generated entries and stored images. +

Create an item identifier or modify an existing entry.
Open the BE-Code Register page. One record is created per operation.
Review the status and the generated images.

The base64-encoded image is stored as a media set. You can reuse the matching GUID identifier in other tables without asking for the image again.