QR-Code-Update-API

Dient zur Aktualisierung der Konfiguration und des Designs eines bestehenden QR-Codes.

Sie können URL, Text oder Telefonnummer sowie Farben, Stile, Logos und weitere Optionen ändern. Der QR-Code wird direkt aktualisiert, ohne neu erstellt zu werden.

Verwenden Sie diese API, wenn Sie Einstellungen ändern möchten, ohne einen neuen QR-Code zu erzeugen.

PUT

/api/link/v1/update/qr

{
    "linkId": "K56t",
    "domain": "https://vvd.bz",
    "type": "url",
    "url": "https://www.instagram.com/vivoldiglobal",
    "logoType": "U",
    "logo": "https://example.com/images/picture/logo/20260425/500x500.png",
    "foreground": "#0269D1FF"
}

Request Parameters

linkId string required
Link-ID. Wenn die URL „https://vvd.im/myBrandQR“ lautet, ist die Link-ID myBrandQR.
domain string required
Default:https://vvd.bz
Link-Domain. Wenn Sie eine benutzerdefinierte Domain verwenden, können Sie diese hier angeben.
type string
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.

Wird type weggelassen, bleibt der aktuelle Typ erhalten. Nur wenn Sie type auf einen anderen Typ ändern, müssen Sie auch das Pflichtfeld des neuen Typs senden; beim gleichen Typ senden Sie nur die Felder, die Sie ändern möchten. Nicht gesendete Felder behalten ihren aktuellen Wert. 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.
Bei einer Aktualisierung ist dies nur erforderlich, wenn auf diesen Typ gewechselt wird; bleibt der Typ gleich, kann es weggelassen werden (der aktuelle Wert bleibt erhalten).
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.
Bei einer Aktualisierung ist dies nur erforderlich, wenn auf diesen Typ gewechselt wird; bleibt der Typ gleich, kann es weggelassen werden (der aktuelle Wert bleibt erhalten).
email string
Empfängeradresse der E-Mail, die beim Scannen erstellt wird.
Erforderlich, wenn type email ist. Maximale Länge: 128 Zeichen.
Bei einer Aktualisierung ist dies nur erforderlich, wenn auf diesen Typ gewechselt wird; bleibt der Typ gleich, kann es weggelassen werden (der aktuelle Wert bleibt erhalten).
emailSubject string
Betreff der E-Mail. Wird verwendet, wenn type email ist. Maximale Länge: 256 Zeichen. Bei einer Aktualisierung löscht ein leerer String den Wert.
emailBody string
Text der E-Mail. Wird verwendet, wenn type email ist. Maximale Länge: 65,535 bytes. Bei einer Aktualisierung löscht ein leerer String den Wert.
message string
Inhalt der SMS. Wird verwendet, wenn type sms ist; die Empfängernummer senden Sie in phone.
Maximale Länge: 128 Zeichen. Bei einer Aktualisierung löscht ein leerer String den Wert.
wifiSsid string
WLAN-Netzwerkname (SSID). Erforderlich, wenn type wifi ist. Maximale Länge: 64 Zeichen.
Bei einer Aktualisierung ist dies nur erforderlich, wenn auf diesen Typ gewechselt wird; bleibt der Typ gleich, kann es weggelassen werden (der aktuelle Wert bleibt erhalten).
wifiEncryption string
Enum:
WPAWEPnopass
WLAN-Sicherheitstyp. Wird verwendet, wenn type wifi ist.
  • WPA: WPA/WPA2/WPA3
  • WEP: WEP
  • nopass: Kein Passwort
Beim Wechsel von einem anderen Typ zu wifi gilt WPA, wenn es weggelassen wird; ist der Typ bereits wifi, bleibt der aktuelle Wert erhalten.
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. Bei einer Aktualisierung löscht ein leerer String den Wert.
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.
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": null
}

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 null

Wann diese API verwenden

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

  • Wenn Sie die Ziel-URL eines bereits verteilten QR-Codes ändern müssen
  • Wenn Sie das Design wie Farben, Logos oder Stile aktualisieren möchten
  • Wenn Sie Inhalte oder Einstellungen ändern möchten, ohne den QR-Code zu löschen
  • Wenn Sie QR-Code-Designs in größerem Umfang aktualisieren müssen, z. B. im Rahmen eines Rebrandings
Die QR-Code-URL bleibt unverändert,
sodass Sie Inhalte aktualisieren können, ohne bereits gedruckte oder offline verwendete QR-Codes ersetzen zu müssen.

Anwendungsfälle

Die QR-Code-Update-API eignet sich für verschiedene praktische Anwendungsfälle:

  • Druckmaterialien & Banner: Nur die Ziel-URL bestehender QR-Codes ändern und so Druckkosten vermeiden
  • Rebranding: QR-Code-Designs gesammelt an neue Markenfarben anpassen
  • Eventbetrieb: Zielseiten saisonal wechseln, ohne den QR-Code zu ändern
  • Geschäfte & Tische: Bestehende QR-Codes bei Menüänderungen auf neue Seiten umstellen

Besonders geeignet, wenn bereits verbreitete QR-Codes weiterverwendet werden sollen.

Wichtige Hinweise

Beachten Sie beim Aktualisieren eines QR-Codes folgende Punkte:

  • Ändern Sie foreground (Vordergrundfarbe) und background (Hintergrundfarbe gemeinsam).
    Eine Änderung nur des Hintergrunds kann die Scan-Genauigkeit durch geringen Kontrast beeinträchtigen.
  • Verwenden Sie einen hellen background, z. B. #FFFFFF (weiß).
    Dunkle Hintergründe können die Erkennung des QR-Musters erschweren.
  • Beim Ändern von type müssen die entsprechenden Datenparameter angegeben werden.
  • Wenn Sie die Gruppe mit grpIdx ändern, wird der QR-Code in die neue Gruppe verschoben und aus der bisherigen entfernt.
Überprüfen Sie die Einstellungen vor dem Anwenden der Änderungen.