Zum Hauptinhalt springen
Die GetQR API befindet sich in der Beta-Phase und steht ausgewählten Workspaces zur Verfügung. Details können sich bis zur allgemeinen Veröffentlichung noch ändern.
Jeder QR-Code hat einen qrType, und der Typ legt fest, was data enthalten muss. Dieser Leitfaden zeigt für jeden Typ das Format, einen funktionierenden Anfrage-Body und was Sie nach dem Druck noch ändern können. Die Beispiele sind Anfrage-Bodys für QR-Code erstellen. Senden Sie sie so:

Alle Typen im Überblick

Wie ein QR-Code aufgelöst wird

Jeder QR-Code besteht aus einem Kurzlink und einer Payload. Zwei Felder tragen den Inhalt: Regeln für alle Typen:
  • Standardwerte. Beim Erstellen wird ein fehlendes oder leeres link.url zu data, und Sie können das gesamte link-Objekt weglassen. Werden beide gesendet und unterscheiden sie sich, gewinnt link.url. Senden Sie beide gleich oder nur data.
  • Was das Bild kodiert. Das Bild kodiert bei allen Typen außer wifi den Kurzlink. So können Sie ändern, wohin ein gedruckter Code führt, und seine Scans werden erfasst. Ein WiFi-QR-Code kodiert das Netzwerk selbst: Sie können ihn nach dem Druck nicht ändern, und seine Scans werden nicht erfasst.
  • Schemata. link.url akzeptiert nur http:, https:, wifi:, mailto:, sms: und begin:. Alles andere, auch geo:, smsto:, matmsg: und tel:, erhält 422 Invalid destination URL, selbst wenn data es akzeptiert.
  • Leere Daten. Ein leeres data überspringt die Typprüfung. Bei einem Weiterleitungstyp muss dann link.url gesetzt sein, sonst erhält der Aufruf 400 Missing destination URL.
  • Struktur. Über die Typprüfung hinaus validiert der Server die Payload nicht. Ein JSON-Typ muss sich nur als JSON-Objekt parsen lassen, und eine vCard muss nur mit BEGIN:VCARD beginnen.
Unten mit Editor markierte Grenzen setzt der Editor im Dashboard durch. Die API akzeptiert auch Payloads, die sie missachten, doch diese werden auf der Landingpage oder im Editor womöglich fehlerhaft dargestellt.

Website

qrType: "website". Anleitung zum Dashboard: Website-QR-Code.
Request body
Fehler:
  • 422 Expected an http(s) URL, e.g. "https://example.com" for qrType "website".
  • 422 Invalid destination URL

Feedback

qrType: "feedback". Anleitung zum Dashboard: Feedback-QR-Code. data ist die http(s)-URL des Feedback-Formulars, zum Beispiel ein Google-Formular oder eine Bewertungsseite. Alles Weitere funktioniert wie bei Website.
Request body

Zahlung

qrType: "payment". Anleitung zum Dashboard: Zahlungs-QR-Code. data ist die Zahlungs-URL des Anbieters, zum Beispiel:
Der Editor im Dashboard erkennt diese Hosts: paypal.me, paypal.com/paypalme, cash.app, venmo.com, buy.stripe.com, stripe.com, square.link und payoneer.com. Bei PayPal ist der Betrag das letzte Pfadsegment. Jede andere http(s)-URL funktioniert ebenfalls, der Editor zerlegt sie aber nicht in Anbieter und Betrag. Alles Weitere funktioniert wie bei Website.
Request body

WhatsApp

qrType: "whatsapp". Anleitung zum Dashboard: WhatsApp-QR-Code. data ist ein wa.me-Link: die internationale Nummer als Ziffern ohne +, optional mit vorausgefülltem Text.
Der Server prüft nur, ob es eine http(s)-URL ist. Das Dashboard liest auch api.whatsapp.com/send-Links. Alles Weitere funktioniert wie bei Website.
Request body

Standort

qrType: "location". Anleitung zum Dashboard: Standort-QR-Code. data ist eine Karten-URL. Verwenden Sie dieses Format, damit der QR-Code im Dashboard bearbeitbar bleibt (query_place_id ist optional):
Jede andere http(s)-URL leitet ebenfalls weiter. Eine geo:-URI besteht die data-Prüfung, wird als Ziel aber abgelehnt. Verwenden Sie sie daher nicht. Alles Weitere funktioniert wie bei Website.
Request body
qrType: "app". Anleitung zum Dashboard: App-Link-QR-Code.
Request body
Fehler:
  • 422 Invalid URL
  • 400 Missing destination URL

E-Mail

qrType: "email". Anleitung zum Dashboard: E-Mail-QR-Code.
Request body
Fehler:
  • 422 Expected a mailto URI, e.g. "mailto:[email protected]?subject=Hello" for qrType "email".

SMS

qrType: "sms". Anleitung zum Dashboard: SMS-QR-Code.
Request body
Fehler:
  • 422 Expected an SMS URI, e.g. "sms:+14155550123?body=Hello" for qrType "sms".

WiFi

qrType: "wifi". Anleitung zum Dashboard: WiFi-QR-Code.
Request body
Fehler:
  • 422 Expected a Wi-Fi payload, e.g. "WIFI:T:WPA;S:MyNetwork;P:secret;H:false;" for qrType "wifi".
Ändern Sie nicht den Typ eines gedruckten WiFi-QR-Codes. Die gedruckten Codes behalten das alte Netzwerk.

Dateibasierte Typen

qrType: "pdf", "image" oder "video". Anleitungen zum Dashboard: PDF, Image, Video. Eine Datei pro QR-Code: PDF-Bundles und Bildergalerien sind über die API nicht verfügbar. Siehe Nicht über die API unterstützt.
Wie Sie die Datei hochladen und ihre fileId erhalten, steht unter Dateien.

vCard

qrType: "vcard". Anleitung zum Dashboard: vCard-QR-Code. Landingpage und Editor lesen nur die unten aufgeführten Zeilenformen. Andere Varianten wie TEL;CELL: oder EMAIL;TYPE=INTERNET: werden gespeichert, erscheinen aber nicht auf der Seite.
  • N:<last>;<first>;;;: Nach- und Vorname. Editor: beide erforderlich, bis zu 40 Zeichen.
  • FN:<first> <last>: wird von der Seite nicht gelesen. Daraus stammt die Bezeichnung in der Dashboard-Liste.
  • ORG:<company> und TITLE:<role>: Firma und Position. Editor: bis zu 40 Zeichen.
  • TEL;TYPE=HOME:, TEL;TYPE=CELL:, TEL;TYPE=WORK:, TEL;TYPE=FAX:: Telefon-, Mobil-, Geschäfts- und Faxnummer (+ und Ziffern).
  • EMAIL:<email>: E-Mail-Adresse.
  • URL:<url>: Website.
  • NOTE:<text>: Zusammenfassung. Maskieren Sie \\, \n, \; und \,. Editor: bis zu 200 Zeichen.
  • ADR:;;<street>;<city>;<state>;<zip>;<country>: Adresse.
  • X-SOCIALPROFILE;TYPE=<platform>:<url> oder URL;TYPE=<PLATFORM>:<url>: Social-Media-Links, eine Zeile pro Plattform.
  • PHOTO;VALUE=URI:<url>: URL des Profilbilds. Hat Vorrang vor jeder Datei-ID.
  • X-GETQR-IMAGE-FILEID:<fileId>: Profilbild (Target logo).
  • X-GETQR-PAGE-LOGO-FILEID:<fileId>: Seitenlogo (Target logo).
  • X-GETQR-LANDING-THEME:p|<0-4> oder X-GETQR-LANDING-THEME:c|#RRGGBB|#RRGGBB|#RRGGBB: Theme der Landingpage, entweder ein Preset-Index (0 bis 4) oder eigene Farben für Hintergrund, Buttons und Symbole.
Soziale Plattformen: facebook, whatsapp, instagram, youtube, tiktok, messenger, snapchat, linkedin, x, reddit, pinterest, telegram, wechat, viber, line.
Request body
Fehler:
  • 422 Expected a vCard payload starting with "BEGIN:VCARD" for qrType "vcard".

Social Media

qrType: "social". Anleitung zum Dashboard: Social-Media-QR-Code. Felder in data:
Request body
Fehler:
  • 422 Expected a JSON object describing the social profile page for qrType "social".
qrType: "multilink". Anleitung zum Dashboard: Multi-Link-QR-Code. Die Felder in data entsprechen denen von Social Media, nur werden firstName, lastName und summary ersetzt durch: In customItems ist logoFileId optional: Dann wird ein Ersatzsymbol angezeigt. Editor: mindestens ein Social-Media-Link oder ein nicht leeres eigenes Element.
Request body
Fehler:
  • 422 Expected a JSON object describing the multi-link page for qrType "multilink".

Event

qrType: "event". Anleitung zum Dashboard: Event-QR-Code. Felder in data:
conference, seminar, workshop, training, webinar, meetup, networking, corporateEvent, productLaunch, tradeShow, jobFair, fundraiser, charity, wedding, engagement, birthday, anniversary, babyShower, graduation, reunion, party, religious, funeralMemorial, ceremony, concert, festival, clubNight, theater, comedy, filmScreening, exhibition, sports, tournament, raceMarathon, fitnessClass, foodDrink, market, openHouse, community, schoolEvent, kids, travelTour
Request body
Fehler:
  • 422 Expected a JSON object describing the event page for qrType "event".

Dateien in QR-Codes

Registrieren Sie eine Datei über Dateien, laden Sie sie hoch und übergeben Sie dann ihre fileId. Verwenden Sie das Target, das zum Zweck passt:
  • pdf, image, video. Der Inhalt eines PDF-, Bild- oder Video-QR-Codes.
  • logo. Profilbilder, Seitenlogos, Symbole eigener Links und Logos in der Mitte.
Dateien, die nie an einen QR-Code angehängt werden, werden nach einer Karenzzeit gelöscht. fileId-Fehler, die beim Erstellen und bei PATCH zurückgegeben werden, wenn fileId gesendet wird: Datei-IDs innerhalb einer Payload (fileId, pageLogoFileId, customItems[].logoFileId, X-GETQR-*-FILEID-Zeilen) werden nicht validiert. Sie werden nur dargestellt, wenn sie mit dem Target logo hochgeladen wurden. Der QR-Code beansprucht sie, sodass die Bereinigung sie nicht löscht.

Typwechsel

Sie können qrType mit QR-Code aktualisieren ändern. Senden Sie data, die zum neuen Typ passen: Die gespeicherte Payload gehört zum alten Typ, daher wird ein Wechsel ohne neue Daten abgelehnt. Nach einer Aktualisierung wird das Ziel in dieser Reihenfolge bestimmt:
  1. vcard, social, multilink, event: immer die gehostete Seite.
  2. Ein im Dashboard erstelltes PDF-Bundle oder eine Bildergalerie: deren Landingpage.
  3. pdf, image, video: die Datei-URL (eine neue fileId, sonst die gespeicherte).
  4. link.url, falls gesendet.
  5. Geänderte data.
  6. Die gespeicherte URL.
Was die einzelnen Wechsel bewirken:
  • Weg von pdf, image oder video. fileId und ein eventuelles Bundle oder eine Galerie werden entfernt.
  • Zu pdf, image oder video. Senden Sie auch fileId, sonst wird die gespeicherte wiederverwendet, die ein vCard-Foto sein kann.
  • Weg von app. Der App-Name, link.ios und link.android werden entfernt, sodass Smartphones dem neuen Ziel folgen.
  • Zu wifi. Das Bild wechselt zur rohen Payload. Bereits gedruckte Codes enthalten weiterhin den Kurzlink, der jetzt auf eine wifi:-URL weiterleitet.
  • Weg von wifi. Gedruckte Codes behalten ihr altes Netzwerk.
  • Zu vcard, social, multilink oder event. Der Kurzlink wird auf die neue gehostete Seite gerichtet.
  • Weg von vcard, social, multilink oder event. Senden Sie die neuen data. Das Ziel folgt ihnen.
Statische QR-Codes aus dem Dashboard haben keinen Kurzlink, daher erhält eine Änderung ihres link.url den Status 422.

Nicht über die API unterstützt

Diese Dashboard-Funktionen sind nicht Teil der v1-API. Unbekannte Felder werden ohne Fehler verworfen, sodass ihr Senden keine Wirkung hat. Im Dashboard erstellte Bundles und Galerien lassen sich über die API weiterhin abrufen, pausieren und löschen, ihre Dateien aber nicht ändern.

Häufige Probleme

link.url verwendet ein Schema, auf das der Kurzlink nicht weiterleiten kann, etwa geo:, smsto:, matmsg: oder tel:. Verwenden Sie die Formate auf dieser Seite.
data ist leer und es gibt kein link.url. Setzen Sie bei app mindestens eines von link.ios, link.android, link.url oder data.
Die Seite liest nur die für den Typ aufgeführten Felder und Zeilenformen. Andere Felder werden gespeichert, aber nicht angezeigt.

Wie geht es weiter?

QR-Codes

Dateien

Anpassung

Zugriffsregeln