API-Referenz

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:

• type: Kurzcode eines Barcode-Typs, z. B. ean13, code128 oder qrcode.
• content: Zeichenkette, die als Barcode kodiert werden soll.

Beispiel-Request:

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

Beispiel-Antwort (gekürzt):

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

Optionale Parameter für alle Barcode-Typen

• scaleX: X-Achsen-Skalierung, ganze Zahl > 0, Standard 2.
• scaleY: Y-Achsen-Skalierung, ganze Zahl > 0, Standard entspricht scaleX.
• scale: Setzt X- und Y-Skalierung gleichzeitig, ganze Zahl > 0.
• rotate: Orthogonale Drehung. Mögliche Werte:
  • N: keine Drehung (Standard)
  • R: 90 Grad im Uhrzeigersinn
  • L: 90 Grad gegen den Uhrzeigersinn
  • I: 180 Grad
• padding: Kurzform für alle vier Padding-Werte.
• paddingwidth: Kurzform für paddingleft und paddingright.
• paddingheight: Kurzform für paddingtop und paddingbottom.
• paddingtop, paddingleft, paddingright, paddingbottom: Padding in Punkten, dreht und skaliert mit dem Bild.
• backgroundcolor: Hintergrundfarbe als Hex-Wert (RRGGBB oder CCMMYYKK).
• barcolor: Balken- bzw. Modulfarbe als Hex-Wert (RRGGBB oder CCMMYYKK).
• parse: Ersetzt Sequenzen wie ^NNN im content durch ihren ASCII-Wert. Nützlich bei code128 oder code39ext, z. B. ^029 für GS oder ^009 für TAB.
  • true: Inhalt parsen
  • false: Inhalt nicht parsen
• parsefnc: Ermöglicht Nicht-Daten-Funktionszeichen über Escape-Sequenzen wie ^FNC1, ^FNC2, ^FNC3, ^LNKA, ^LNKC.
  • true: Funktionszeichen parsen
  • false: Funktionszeichen nicht parsen

Beispiel-Request mit Gestaltung:

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

Zum Vergrößern anklicken

Optionale Parameter für 1D-Barcodes

• includetext: Zeigt den Inhalt unterhalb des Codes an.
  • true: Text anzeigen
  • false: Text ausblenden
• textxalign: Ausrichtung des Begleittextes. Mögliche Werte: center, left, right.
• textfont: Schriftart, Standard arial. Beispiele: CONS, ARIAL.
• textcolor: Textfarbe als Hex-Wert (RRGGBB oder CCMMYYKK).

Beispiel-Request mit Text:

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

Zum Vergrößern anklicken

Optionale Parameter für 2D-Barcodes

• eclevel: Fehlerkorrektur-Stufe bei QR-Codes. Mögliche Werte:
  • L: niedrig, bis zu 7 % Wiederherstellung
  • M: mittel, bis zu 15 % Wiederherstellung
  • Q: quartile, bis zu 25 % Wiederherstellung
  • H: hoch, bis zu 30 % Wiederherstellung

Beispiel-Request QR-Code mit hoher Fehlerkorrektur und Farben:

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

Zum Vergrößern anklicken

Unterstützte Barcode-Typen

Ergebnis

• Sie können jeden unterstützten Barcode-Typ per GET-Request erzeugen.
• Sie steuern Skalierung, Drehung, Padding, Farben und optionale 1D-/2D-Parameter gezielt.
• Die Antwort lässt sich direkt als Bild einbetten.