QR-Code-API

Erstellen Sie anpassbare QR-Codes mit nur einem API-Aufruf.

Kodieren Sie URL, Text oder Telefonnummer im QR-Code,
und passen Sie Farben, Marker, Stil und Logo an Ihre Marke an.

Jeder QR-Code wird mit einem Link bereitgestellt—sofort nutzbar oder als Bild downloadbar.

  • Der QR-Code ist unter https://vvd.bz/[linkId]/qr abrufbar, Größe per size-Parameter anpassbar.
  • Beispiel: https://vvd.bz/hj7V/qr?size=500 → liefert einen 500px QR-Code (max. 4096px)
POST

/api/link/v1/create/qr

{
    "type": "url",
    "url": "https://www.youtube.com/vivoldi365",
    "domain": "https://vvd.bz",
    "logoType": "U",
    "logo": "https://example.com/images/picture/logo/500x500.png"
}

Request Parameters

domain string required
Default:https://vvd.bz
Link-Domain. Standard ist https://vvd.bz. Wenn brandLinkId gesetzt ist, wird automatisch https://vvd.im verwendet.
Bei Nutzung einer eigenen Domain kann diese hier angegeben werden.
type string required
Default:url
Enum:
urltextphoneemailsmswifi
QR-Code-Typ.
  • url: Webseiten-URL
  • text: Textinhalt
  • phone: Telefonnummer
  • email: E-Mail (Empfänger, Betreff, Text)
  • sms: SMS (Empfängernummer, Nachricht)
  • wifi: WLAN-Zugang (Netzwerkname, Sicherheit, Passwort)
Je nach Typ sind unterschiedliche Felder erforderlich.

Die bisherigen Feldnamen qrEml, qrEmlTtl, qrEmlBody, qrSmsPhnNo, qrSmsBody, qrWifiSsid, qrWifiEncrypt, qrWifiPwd werden weiterhin akzeptiert, sind aber veraltet. Bitte verwenden Sie die oben genannten Namen. Wird dasselbe Feld unter beiden Namen gesendet, wird ein 400-Fehler zurückgegeben.

url string
Ziel-URL beim Scannen des QR-Codes. Erforderlich, wenn type = url. Muss eine vollständige http/https-URL sein.
Maximal 2.000 Bytes.
text string
Textinhalt im QR-Code. Wird verwendet, wenn type = text. Wird beim Scannen direkt angezeigt.
Geeignet für Nachrichten oder Codes. Darstellung kann je nach Gerät variieren.
Maximal 65.535 Bytes.
phone string
Telefonnummer beim Scannen. Wird verwendet, wenn type = phone und öffnet die Wählfunktion.
Maximal 32 Zeichen. Internationale Schreibweise empfohlen.
Wenn type sms ist, ist dies die Empfängernummer der Nachricht und erforderlich. Bindestriche (-) werden beim Speichern entfernt.
email string
Empfängeradresse der E-Mail, die beim Scannen erstellt wird.
Erforderlich, wenn type email ist. Maximale Länge: 128 Zeichen.
emailSubject string
Betreff der E-Mail. Wird verwendet, wenn type email ist. Maximale Länge: 256 Zeichen.
emailBody string
Text der E-Mail. Wird verwendet, wenn type email ist. Maximale Länge: 65,535 bytes.
message string
Inhalt der SMS. Wird verwendet, wenn type sms ist; die Empfängernummer senden Sie in phone.
Maximale Länge: 128 Zeichen.
wifiSsid string
WLAN-Netzwerkname (SSID). Erforderlich, wenn type wifi ist. Maximale Länge: 64 Zeichen.
wifiEncryption string
Enum:
WPAWEPnopass
WLAN-Sicherheitstyp. Wird verwendet, wenn type wifi ist.
  • WPA: WPA/WPA2/WPA3
  • WEP: WEP
  • nopass: Kein Passwort
Wird es beim Erstellen weggelassen, gilt WPA.
wifiPassword string
WLAN-Passwort. Wird verwendet, wenn type wifi ist; Leerzeichen am Anfang und Ende werden beim Speichern entfernt.
Maximale Länge: 32 Zeichen. Bei Sicherheitstyp nopass leer lassen.
logoType string
Default:N
Enum:
NCU
Logo-Typ im Zentrum des QR-Codes.
  • N: Kein Logo
  • C: Standard-Logo
  • U: Benutzerdefiniertes Logo

Ein Logo stärkt die Markenwahrnehmung. Verfügbar ab Personal-Tarif.

logo string
URL des Logos im QR-Code. Verwendet bei logoType = U. Muss öffentlich erreichbar sein.
Empfohlen: quadratisch, transparentes PNG. Maximal 500x500 px.
foreground string
Vordergrundfarbe (HEX). Standard schwarz.
Achten Sie auf ausreichenden Kontrast.
Default: #000000FF
background string
Hintergrundfarbe (HEX). Standard weiß.
Dunkle Hintergründe können die Scanrate reduzieren.
Default: #FFFFFFFF
markerColor string
Farbe der Positionsmarker.
Default: #000000FF
markerBorderColor string
Randfarbe der Marker.
Default: #000000FF
style string
Visueller QR-Stil. Vorschau im Dashboard verfügbar.
markerStyle string
Marker-Design. Unterstützt verschiedene Formen.
grpIdx integer
Gruppen-ID zur Organisation.
brandLinkId string
Wird automatisch generiert, wenn nicht gesetzt. Standarddomain https://vvd.im
ttl string
Interner Titel.
memo string
Interne Notiz (nicht sichtbar für Nutzer).
qrBypassYn string
Y: Direktzugriff (ohne Tracking)
N: über Kurzlink (Tracking aktiv)
pushNotifyYn string
Push-Benachrichtigung bei Scan.
mailNotifyYn string
E-Mail-Benachrichtigung bei Scan.
delYmdt datetime
Zeitpunkt der automatischen Löschung.
{
    "code": 0,
    "message": "",
    "result": "https://vvd.bz/K56t"
}

Response Parameters

code integer
Antwortcode: 0 = Erfolg, andere Werte = Fehler
message string
Antwortnachricht. Wenn der Code nicht 0 ist, wird eine Fehlermeldung zurückgegeben.
result string
Antwortwert. Der Kurzlink wird zurückgegeben.
Beispiel: https://vvd.bz/jH3d

Wann diese API verwenden

Verwenden Sie die QR-Code-API in folgenden Fällen:

  • Wenn QR-Codes automatisiert und in großem Umfang über externe Systeme erstellt werden sollen
  • Wenn Sie QR-Codes mit individuellen Farben und Logos per API generieren möchten
  • Wenn QR-Codes dynamisch für Produkte, Visitenkarten oder Druckmaterialien erstellt werden müssen
  • Wenn QR-Codes für URLs, Text oder Telefonnummern benötigt werden
Konzipiert für Automatisierung und Skalierung—nicht für manuelle Erstellung im Dashboard.

QR-Code-Typen

Aktuell unterstützt die API folgende QR-Code-Typen:

  • url: QR-Code mit Webseiten-URL. Bis zu 2.000 Bytes
  • text: QR-Code mit Textinhalt. Bis zu 65.535 Bytes
  • phone: QR-Code mit Telefonnummer. Bis zu 32 Zeichen

Das Dashboard bietet weitere Typen wie E-Mail oder WiFi, die API ist derzeit jedoch eingeschränkt.
Weitere Typen werden in zukünftigen Updates ergänzt.

Anwendungsfälle

Die QR-Code-API eignet sich für viele Einsatzbereiche:

  • E-Commerce: Automatische QR-Erstellung pro Produkt für Verpackung und Etiketten
  • Visitenkarten & Druck: Erstellung gebrandeter QR-Codes mit individuellen Farben und Logos
  • Offline-Events: Skalierbare Generierung individueller QR-Codes für Tickets und Teilnehmer
  • Gastronomie & Einzelhandel: Automatische Aktualisierung von Menü- und Tisch-QR-Codes bei Änderungen
Ideal für schnellen und nahtlosen Zugriff im mobilen Umfeld.

Design- und Stiloptionen

Passen Sie das Erscheinungsbild Ihrer QR-Codes flexibel an.

Definieren Sie Farben mit foreground (Standard #000000FF), background (Standard #FFFFFFFF), markerColor (Standard #000000FF) und markerBorderColor (Standard #000000).

Wählen Sie das Muster über style—rectangles, small-rectangles, dots, round, rows, columns, snakes, water—und passen Sie die Marker mit markerStyle an.

Fügen Sie ein Logo hinzu, indem Sie logoType auf U (Upload) oder C (Standardlogo) setzen. Verfügbar ab Personal-Tarif.
Das Bild wird über logo angegeben. Empfohlen: bis zu 500×500px.

Wichtige Hinweise

Beachten Sie beim Erstellen von QR-Codes folgende Punkte:

  • Geringer Farbkontrast kann die Scan-Genauigkeit beeinträchtigen
  • Zu komplexe Designs können die Scanleistung verschlechtern
  • Die API unterstützt derzeit nur eine begrenzte Auswahl an QR-Typen
Für zuverlässige Ergebnisse sollten Sie mit den Standardeinstellungen beginnen und diese bei Bedarf anpassen.