QR- und Barcode-Generierung on Product Documentation

Überblick

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

Zweck

BE-Code stellt eine API zur Verfügung, die auf Anfrage QR- und Barcode-Bilder erzeugt. Die Antwort enthält das Bild direkt als base64-kodiertes PNG und lässt sich so ohne Umwege in Dokumente, Formulare und Portale einbinden.

Fachlicher Nutzen

Unterstützt über 90 Barcode-Typen für Industrie, Logistik, Gesundheitswesen und Postal-Services.
Liefert Bilder direkt als base64-kodiertes PNG; ideal für Word-Layouts, Berichte und Portale.
Erlaubt feingranulare Gestaltung: Skalierung, Rotation, Abstände, Farben, Textanzeige bei 1D-Codes sowie Fehlerkorrektur bei QR-Codes.
Kapselt unterschiedliche Codierungen hinter einer einheitlichen GET-Schnittstelle.

Inhaltlicher Fokus

Einheitliche HTTP-GET-Schnittstelle

Jeder Aufruf liefert ein JSON-Objekt mit zwei Feldern: data enthält das Bild als base64-kodiertes PNG, message die Statusmeldung. Damit lassen sich Barcodes serverseitig genauso einfach einbinden wie clientseitig.

API-Referenz

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

Zweck

Diese Seite beschreibt die HTTP-GET-Schnittstelle von BE-Code vollständig: den Basis-Request, alle optionalen Parameter und die vollständige Liste der unterstützten Barcode-Typen.

Kontext

Die API liefert zu jedem Aufruf ein JSON-Objekt mit zwei Feldern:

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

data enthält das Barcode-Bild als base64-kodiertes PNG (mit MIME-Prefix data:image/png;base64,).
message enthält eine Statusmeldung zur Anfrage.

Voraussetzungen

Eine erreichbare BE-Code-Instanz über HTTPS.
Zugriffsdaten für die Basic-Authentication. Zugangsdaten für eine Testinstanz sind auf Anfrage beim BE-terna-Support erhältlich.

Basis-Request

Jeder Aufruf enthält mindestens die Parameter type und content:

Beispiel: Integration in Business Central

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

Zweck

Dieses Beispiel zeigt, wie BE-Code in Business Central eingebunden wird und wie Sie die Ausführung über das BE-Code-Register nachvollziehen. Das Beispiel orientiert sich am ausgelieferten Beispiel-Szenario für Artikel-Identifikatoren.

Kontext

BE-Code wird als Middleware-Service betrieben. Die Einrichtung ist unter Einrichtung BE-Code beschrieben.
Beim Anlegen oder Ändern eines Artikel-Identifikators erzeugt der mitgelieferte Event-Subscriber automatisch einen Eintrag im BE-Code-Register und ruft den Service auf.

Voraussetzungen

BE-Code-Service ist verfügbar (On-Premises oder Azure Container Instance).
Zugangsdaten für die Basic-Authentication des Service liegen vor.
Die BE-Code-App ist in Business Central installiert.

Prozesskatalog

Process Schritt 1 – BE-Code-Setup pflegen Server-URL und Authentifizierung hinterlegen und die Verbindung testen. +

Öffnen Sie in Business Central die Seite BE-Code Setup.
Hinterlegen Sie die Server-API-URL, z. B. https://<fqdn>:1880/becode.
Tragen Sie die Basic-Authentication-Zugangsdaten ein.
Aktivieren Sie bei Bedarf die Integration für Artikel-Identifikatoren, pflegen Sie den API-Pfad und den Standard-Identifikator-Parameter.
Wählen Sie die Aktion Verbindung prüfen. Eine Erfolgsmeldung bestätigt, dass BE-Code erreichbar ist.

Process Schritt 2 – Ausführung im BE-Code-Register prüfen Die erzeugten Einträge und die gespeicherten Bilder nachvollziehen. +

Legen Sie einen Artikel-Identifikator an oder ändern Sie einen bestehenden Eintrag.
Öffnen Sie die Seite BE-Code Register. Für jeden Vorgang wird ein Datensatz erzeugt.
Prüfen Sie den Status und die erzeugten Bilder.

Das base64-kodierte Bild wird als Medienset gespeichert. Der dazugehörige GUID-Identifikator lässt sich in weiteren Tabellen wiederverwenden, ohne dass das Bild erneut angefordert werden muss.