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 Vorlage speichert ein wiederverwendbares Design: styles, frameOptions und logoOptions. Sie enthält nie Inhalt oder einen Link. Vorlagen stehen allen im Workspace zur Verfügung.

Vorlage anwenden

Übergeben Sie templateId, wenn Sie einen QR-Code erstellen. Das Design der Vorlage wird auf den neuen QR-Code angewendet. Design-Objekte, die Sie in derselben Anfrage senden, werden darübergelegt.
  • Kopiert, nicht verknüpft. Der QR-Code behält seine eigene Kopie des Designs. Spätere Änderungen an der Vorlage oder ihr Löschen wirken sich nicht auf ihn aus.
  • Nur Custom designs. Eine Vorlage mit designKind branded oder ai lässt sich über die API nicht anwenden und liefert 422 (art_template_unsupported).
  • Nur Ihr Workspace. Eine unbekannte Vorlage oder eine aus einem anderen Workspace liefert 404.
string
erforderlich
Bearer gefolgt von Ihrem API-Schlüssel. Siehe Authentifizierung.
string
application/json. Erforderlich bei Anfragen mit Body.

Das Vorlagenobjekt

string
ID der Vorlage, zum Beispiel qrt_8Hs2mQvKpLd4RtYw.
string
Name, der bei der Auswahl einer Vorlage angezeigt wird.
string
Schreibgeschützt. custom ist ein Design, das die API vollständig bearbeiten kann. branded und ai sind ein im Dashboard erstelltes Branded design oder AI design: Sein Bild lässt sich über die API nicht bearbeiten und bleibt erhalten, wenn Sie die anderen Designfelder ändern.
object
Das gespeicherte Design. Jedes Feld hat denselben Aufbau wie das gleichnamige Anfragefeld, sodass Sie es zurücksenden können.
string
Erstellungsdatum, ISO 8601.
string
Datum der letzten Aktualisierung, ISO 8601.

Vorlagen auflisten

GET /api/v1/templates Liefert die Vorlagen Ihres Workspace, die neuesten zuerst. Die Liste ist paginiert: siehe Paginierung.
integer
Standard:"1"
Zurückzugebende Seite, 1 oder höher.
integer
Standard:"100"
Ergebnisse pro Seite, 1 bis 100.

Vorlage erstellen

POST /api/v1/templates Speichert ein neues Design. Antwortet mit 201 Created. Die Designfelder werden mit den Katalogen unter Anpassung abgeglichen, sodass eine unbekannte Form, ein unbekannter Rahmen oder ein unbekanntes Logo mit 422 abgelehnt wird.
string
erforderlich
Name, der bei der Auswahl einer Vorlage angezeigt wird, 1 bis 40 Zeichen.
object
Formen und Farben von Punkten und Ecken. Siehe Anpassung.
object
Rahmen um den QR-Code samt Text der Handlungsaufforderung. Siehe Anpassung.
object
Logo in der Mitte: ein vorgeschlagenes Logo oder Ihre eigene Datei, hochgeladen mit dem Target logo von Dateien. Siehe Anpassung.

Vorlage abrufen

GET /api/v1/templates/{templateId}
string
erforderlich
ID der Vorlage. Nehmen Sie sie aus der Antwort der Liste oder der Erstellung.

Vorlage aktualisieren

PATCH /api/v1/templates/{templateId} Senden Sie nur die Felder, die Sie ändern möchten. Design-Objekte werden mit dem gespeicherten Design zusammengeführt, sodass ein unvollständiges styles den Rest beibehält. Bereits aus der Vorlage erstellte QR-Codes behalten das Design, mit dem sie erstellt wurden.
string
erforderlich
ID der Vorlage.
string
Neuer Name, 1 bis 40 Zeichen.
object
Änderungen am Stil, zusammengeführt mit den gespeicherten styles.
object
Änderungen am Rahmen, zusammengeführt mit dem gespeicherten Rahmen.
object
Änderungen am Logo, zusammengeführt mit dem gespeicherten Logo.

Vorlage löschen

DELETE /api/v1/templates/{templateId} Löscht die Vorlage. Daraus erstellte QR-Codes behalten ihr Design.
string
erforderlich
ID der Vorlage.

Vorlage duplizieren

POST /api/v1/templates/{templateId}/duplicate Erstellt eine Kopie mit dem Namen <name> copy, mit eigener ID und einem unabhängigen Design, das Sie frei bearbeiten können. Erwartet keinen Anfrage-Body. Antwortet mit 201 Created.
string
erforderlich
ID der zu kopierenden Vorlage.

Häufige Probleme

Die templateId passt zu keiner Vorlage in Ihrem Workspace. Nehmen Sie sie aus Vorlagen auflisten.
Ein Designfeld passt nicht zu den Katalogen, zum Beispiel ein unbekannter Punkttyp, Rahmen oder ein unbekanntes vorgeschlagenes Logo. Die Meldung nennt das Feld. Siehe Anpassung.
Die Vorlage verwendet ein Branded design oder AI design. Wenden Sie stattdessen eine Vorlage mit designKind custom an.

Wie geht es weiter?

Anpassung

QR-Codes

Vorlagen in der App

Dateien