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.
Eine Massenerstellung macht aus einer Liste von Namen und URLs Website-QR-Codes mit einem gemeinsamen Design. Sie läuft im Hintergrund: Starten Sie sie, fragen Sie ihren Fortschritt ab und laden Sie dann das ZIP-Archiv herunter.

So funktioniert es

1

Massenerstellung starten

Senden Sie Ihre Zeilen mit Aus JSON erstellen oder Aus einer CSV-Datei erstellen. Die API antwortet mit 202, der Massenerstellung und ihrer id.
2

Fortschritt abfragen

Rufen Sie alle paar Sekunden Massenerstellung abrufen auf, bis status den Wert completed oder failed hat.
3

Archiv herunterladen

Wenn status den Wert completed hat, rufen Sie Archiv herunterladen auf, um ein ZIP mit den QR-Code-Bildern zu erhalten.
  • Limit. Bis zu 100 Zeilen pro Massenerstellung.
  • Eine nach der anderen. Pro Workspace läuft nur eine Massenerstellung. Wenn Sie eine weitere starten, während eine läuft, erhalten Sie die laufende zurück.
  • Idempotenz. Jede Anfrage braucht einen idempotencyKey. Wiederholen Sie eine Anfrage mit demselben Schlüssel und demselben Body, erhalten Sie die bereits gestartete Massenerstellung. Derselbe Schlüssel mit einem anderen Body liefert 422.
  • Zeilen. Jede Zeile braucht einen name und eine url. Siehe Zeilen.
  • Tarif. Im Tarif Single QR ist die Massenerstellung nicht verfügbar: Die Anfrage liefert 403 exceeded_limit.

Zeilen

  • Name. Wird zum Titel des QR-Codes. Wird getrimmt und auf 40 Zeichen gekürzt. Wiederholte Namen (ohne Beachtung der Groß- und Kleinschreibung) erhalten eine Nummer: Menu, Menu 2, Menu 3.
  • URL. Wird zum Ziel. Sie muss eine http- oder https-Adresse mit einer echten Domain sein, etwa example.com/menu, und darf keine Leerzeichen enthalten. Eine URL ohne Schema erhält https://.
  • Leere Zeilen. Zeilen ohne Namen und ohne URL werden übersprungen. Eine Zeile mit nur einem von beiden wird abgelehnt.
Jeder QR-Code ist ein website-QR-Code mit Kurzlink. Siehe QR-Typen.
string
erforderlich
Bearer gefolgt von Ihrem API-Schlüssel. Siehe Authentifizierung.
string
application/json für Aus JSON erstellen, multipart/form-data für Aus einer CSV-Datei erstellen.

Das Objekt der Massenerstellung

string
ID der Massenerstellung, zum Beispiel cm2k7x9qb0003ax8eb4f6gh2t.
string
queued, processing, packaging oder completed. Eine fehlgeschlagene oder abgebrochene Massenerstellung durchläuft rollingBack bis failed.
string
Name der Quelldatei.
integer
Anzahl der Zeilen.
integer
Bisher erstellte QR-Codes.
integer
Bisher gerenderte QR-Code-Bilder.
integer
Gesamtfortschritt, 0 bis 100. Das Erstellen reicht bis 40, das Rendern bis 90, das Verpacken ist 95, und completed ist 100.
boolean
true, wenn eine laufende Massenerstellung seit 2 Minuten keinen Fortschritt gemacht hat. Fragen Sie weiter ab: Massenerstellung abrufen startet eine hängende Massenerstellung neu.
object | null
Wenn status den Wert failed hat: code und message. Eine abgebrochene Massenerstellung hat den Code cancelled_by_user. Eine fehlgeschlagene Massenerstellung wird zurückgerollt, sodass keiner ihrer QR-Codes erhalten bleibt.
string | null
Pfad von Archiv herunterladen, sobald status den Wert completed hat.
string
Startdatum, ISO 8601.
string
Datum der letzten Aktualisierung, ISO 8601.
string | null
Abschlussdatum, ISO 8601.
string | null
Datum des Fehlschlags, ISO 8601.

Aktuelle Massenerstellung abrufen

GET /api/v1/bulk-qr-creations Liefert die Massenerstellung, die in Ihrem Workspace noch läuft. Läuft keine, liefert der Endpunkt die zuletzt beendete (completed oder failed), bis sie verworfen wird: Das geschieht durch das Herunterladen ihres Archivs oder durch Verwerfen im Dashboard. Andernfalls liefert er null. Verwenden Sie ihn, um die Überwachung nach einem Neustart fortzusetzen.

Aus JSON erstellen

POST /api/v1/bulk-qr-creations Startet eine Massenerstellung aus einer Liste von Zeilen. Antwortet mit 202 Accepted. Die Massenerstellung läuft im Hintergrund.
object[]
erforderlich
Zu erstellende QR-Codes, bis zu 100. Jede Zeile ist { "name": "...", "url": "..." } und akzeptiert keine weiteren Felder. Siehe Zeilen.
object
erforderlich
Design für alle QR-Codes: styles, frameOptions und logoOptions, alle optional. Senden Sie {} für das Standarddesign. Andere Felder werden abgelehnt. Siehe Anpassung.
string
erforderlich
Name, der im Dashboard angezeigt und für das Archiv verwendet wird, 1 bis 255 Zeichen.
string
erforderlich
Ihr eigener Schlüssel für diese Massenerstellung, 8 bis 100 Zeichen.

Aus einer CSV-Datei erstellen

POST /api/v1/bulk-qr-creations/csv Wie Aus JSON erstellen, erwartet die Zeilen aber als CSV-Datei, gesendet als multipart/form-data. Antwortet mit 202 Accepted. Die Datei muss eine .csv-Datei mit höchstens 1.000.000 Bytes sein. Ihre Kopfzeile muss genau name,url lauten, gefolgt von bis zu 100 Datenzeilen. Siehe CSV-Format.
file
erforderlich
Die CSV-Datei.
string
erforderlich
Das Design-Objekt, als JSON serialisiert, zum Beispiel {"styles":{"dotsOptions":{"type":"rounded"}}}. Senden Sie {} für das Standarddesign.
string
erforderlich
Ihr eigener Schlüssel für diese Massenerstellung, 8 bis 100 Zeichen.
string
Name, der im Dashboard angezeigt und für das Archiv verwendet wird, bis zu 255 Zeichen. Standard ist der Name der hochgeladenen Datei.

Massenerstellung abrufen

GET /api/v1/bulk-qr-creations/{id} Liefert Status und Fortschritt einer Massenerstellung. Fragen Sie den Endpunkt ab, solange status den Wert queued, processing oder packaging hat. downloadUrl erscheint, sobald das Archiv bereit ist.
string
erforderlich
ID der Massenerstellung. Nehmen Sie sie aus der Antwort beim Erstellen oder beim Abruf der aktuellen Massenerstellung.

Massenerstellung abbrechen

DELETE /api/v1/bulk-qr-creations/{id} Stoppt eine laufende Massenerstellung und löscht die QR-Codes, die sie bereits erstellt hat. Das Zurückrollen erfolgt während der Anfrage, daher hat die Antwort normalerweise status failed und error.code cancelled_by_user. Wird eine bereits fehlgeschlagene Massenerstellung abgebrochen, wird sie unverändert zurückgegeben.
Eine abgeschlossene Massenerstellung lässt sich nicht abbrechen: Die Anfrage liefert 400. Löschen Sie ihre QR-Codes stattdessen einzeln über QR-Codes.
string
erforderlich
ID der Massenerstellung.

Archiv herunterladen

GET /api/v1/bulk-qr-creations/{id}/download Liefert ein ZIP-Archiv mit einem JPEG in 1024 px pro QR-Code, benannt nach seiner Zeile: 001-Menu.jpg, 002-Wine list.jpg und so weiter. Das Archiv ist nach sourceFilename benannt. Verfügbar, sobald status den Wert completed hat. Mit dem Herunterladen wird die Massenerstellung verworfen, sodass Aktuelle Massenerstellung abrufen sie nicht mehr liefert.
string
erforderlich
ID der Massenerstellung.

Häufige Probleme

Die Meldung nennt die Zeile. Jede URL muss eine http- oder https-Adresse mit einer echten Domain sein, etwa example.com/menu. Korrigieren Sie die Zeile und senden Sie die Anfrage erneut.
Die erste Zeile der CSV-Datei muss name,url lauten, in dieser Reihenfolge, kleingeschrieben und ohne weitere Spalten.
Schlüssel lassen sich nicht für einen anderen Stapel wiederverwenden. Senden Sie einen neuen idempotencyKey.
Die Massenerstellung ist noch nicht abgeschlossen. Fragen Sie weiter ab, bis status den Wert completed hat.
Die Massenerstellung ist bereits abgeschlossen und lässt sich daher nicht zurückrollen.
Ihr Workspace nutzt den Tarif Single QR, der keine Massenerstellung enthält. Wechseln Sie zu einem höheren Tarif.
In Ihrem Workspace läuft noch eine andere Massenerstellung, oder Sie haben einen idempotencyKey wiederverwendet. Warten Sie, bis sie abgeschlossen ist, oder verwenden Sie einen neuen Schlüssel.

Wie geht es weiter?

Anpassung

QR-Codes

Massenerstellung in der App

CSV-Format