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.
/api/v1 auf.
Was Sie tun können
QR-Codes
QR-Codes erstellen, auflisten, aktualisieren, pausieren, duplizieren, löschen und herunterladen.
Analytics
Scan-Summen und Aufschlüsselungen für einen QR-Code oder den gesamten Workspace.
Berichte
Einen einmaligen Bericht exportieren oder wiederkehrende Berichts-E-Mails planen.
Vorlagen
Designs speichern und auf neue QR-Codes anwenden.
Massenerstellung
Bis zu 100 QR-Codes auf einmal aus JSON oder einer CSV-Datei erstellen.
Dateien
PDFs, Bilder, Videos und Logos für Ihre QR-Codes hochladen.
Statusprüfung
Prüfen, ob die API erreichbar ist. Kein API-Schlüssel nötig.
Leitfäden
QR-Typen
Das Datenformat für jeden der 16 QR-Typen.
Anpassung
Punktstile, Ecken, Farben, Rahmen und Logos.
Zugriffsregeln
Zeitpläne, Scan-Limits, Passwörter, Pausieren und Löschen.
Basis-URL
Alle Endpunkte liegen unter einer gemeinsamen Basis-URL:Versionierung
Die API-Version ist Teil des Pfads: Jeder Endpunkt liegt unter/api/v1/.
- Inkompatible Änderungen erscheinen unter einem neuen Versionspräfix wie
/api/v2/, und/api/v1/funktioniert weiter. - Ergänzungen wie neue optionale Felder oder neue Endpunkte können innerhalb von v1 hinzukommen. Ignorieren Sie Antwortfelder, die Ihr Code nicht kennt.
Schnellstart
1
API-Schlüssel abrufen
Erzeugen oder zeigen Sie Ihren Schlüssel in den Kontoeinstellungen an. Siehe Authentifizierung.
2
Prüfen, ob die API erreichbar ist
{ "status": "ok", "version": "v1" }.3
Ersten QR-Code erstellen
201 und dem neuen QR-Code, einschließlich id und shortLink.4
Bild herunterladen
Anfragen und Antworten
- Format. Senden Sie Anfrage-Bodys als JSON mit
Content-Type: application/json. Ausnahme ist der CSV-Upload für die Massenerstellung, dermultipart/form-dataverwendet. - Antworten. Antworten sind JSON. Downloads wie QR-Bilder und ZIP-Archive der Massenerstellung liefern die Datei selbst.
- Datumsangaben. Datumsangaben sind ISO-8601-Strings in UTC, zum Beispiel
2026-08-01T10:00:00.000Z. - Query-Parameter. Boolesche Parameter erwarten die Strings
trueoderfalse. - Teilaktualisierungen.
PATCH-Endpunkte ändern nur die Felder, die Sie senden. - Geheimnisse. Antworten enthalten nie Passwörter oder interne Kennungen. Ein passwortgeschützter QR-Code meldet nur
passwordProtected: true. - Workspace. Jede Anfrage läuft in dem Workspace, zu dem Ihr API-Schlüssel gehört. Sie übergeben keine Workspace-ID. Siehe Zugriff und Rollen.
- Fehler. Fehlgeschlagene Anfragen liefern ein
error-Objekt mit einem stabilencode. Siehe Fehler.
Paginierung
Listen-Endpunkte (QR-Codes, Vorlagen und geplante Berichte) akzeptieren zwei Query-Parameter:
Sie antworten mit einem
data-Array und einem pagination-Objekt:
Fordern Sie die nächste Seite an, solange
hasMore den Wert true hat. Eine pageSize über 100 liefert 422.
Idempotenz
Nach einem Netzwerkfehler wissen Sie unter Umständen nicht, ob eine Anfrage angekommen ist. Um QR-Code erstellen gefahrlos zu wiederholen, senden Sie einenIdempotency-Key-Header mit einem eindeutigen Wert Ihrer Wahl:
- Wiederholen Sie die Anfrage innerhalb von 24 Stunden mit demselben Schlüssel, erhalten Sie die ursprüngliche Antwort, statt einen zweiten QR-Code zu erstellen.
- Der Antwort-Header
x-idempotent-replayisttruebei einer wiederholt ausgelieferten Antwort undfalsebei einer neuen. - Läuft die erste Anfrage mit diesem Schlüssel noch, antwortet die API mit
409 conflict. Wiederholen Sie sie, sobald sie abgeschlossen ist. - Wird ein Schlüssel mit einem anderen Anfrage-Body wiederverwendet, lautet die Antwort
422 unprocessable_entity. - Ohne den Header gilt ein identischer Anfrage-Body, der innerhalb von 30 Sekunden gesendet wird, als Duplikat.
idempotencyKey im Anfrage-Body. Siehe Massenerstellung.