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.
PDF-, Bild- und Video-QR-Codes verweisen auf eine Datei, und auch ein eigenes Logo ist eine Datei. Das Hochladen erfolgt in zwei Schritten: Registrieren Sie die Datei, um eine URL zu erhalten, und senden Sie dann die Bytes an diese URL.

​
Datei hochladen

1

Datei registrieren

Rufen Sie Datei-Upload registrieren mit target, contentType und size der Datei auf. Das target bestimmt die zulässigen Content-Types und die Größenbegrenzung. Sie erhalten eine fileId und eine uploadUrl.
2

Datei senden

Senden Sie die Datei mit einer PUT-Anfrage an uploadUrl. Ihr Content-Type und ihre Content-Length müssen exakt mit dem registrierten contentType und der registrierten size übereinstimmen: Alles andere wird abgelehnt. Die URL ist vorsigniert, fügen Sie also keinen API-Schlüssel hinzu. Sie läuft nach 10 Minuten ab.
3

Datei-ID verwenden

Übergeben Sie fileId, wenn Sie einen QR-Code erstellen:
  • Als fileId für einen pdf-, image- oder video-QR-Code. Laden Sie die Datei mit dem passenden Target hoch.
  • Als fileId für das Profilbild eines vcard-, social-, multilink- oder event-QR-Codes. Laden Sie die Datei mit dem Target logo hoch.
  • Als logoOptions.fileId, mit logoOptions.type auf uploaded, für ein eigenes Logo. Laden Sie die Datei mit dem Target logo hoch. Siehe Anpassung.

​
Limits

  • Reiner MIME-Typ. Senden Sie einen einzelnen Typ mit Subtyp in Kleinbuchstaben, etwa image/png. Parameter wie ;charset= und Listen werden abgelehnt.
  • Kein SVG. XML-basierte Typen wie image/svg+xml werden nicht akzeptiert. Laden Sie eine Rastergrafik wie image/png oder image/jpeg hoch.
​
string
erforderlich
Bearer gefolgt von Ihrem API-Schlüssel. Siehe Authentifizierung.
​
string
erforderlich
application/json.

​
Datei-Upload registrieren

POST /api/v1/files Registriert eine Datei und liefert eine vorsignierte URL, an die Sie sie hochladen. Dieser Aufruf lädt die Datei selbst nicht hoch.
​
string
erforderlich
Wofür die Datei gedacht ist: pdf, image, video oder logo. Legt die zulässigen Content-Types und die Größenbegrenzung fest. Siehe Limits.
​
string
erforderlich
MIME-Typ der Datei, zum Beispiel application/pdf, ohne Parameter. Die Upload-Anfrage muss genau diesen Content-Type senden.
​
integer
erforderlich
Exakte Größe der Datei in Bytes, eine positive ganze Zahl. Wird mit dem Limit für das Target abgeglichen. Die Upload-Anfrage muss genau diese Content-Length senden.
​
string
Ursprünglicher Dateiname, bis zu 255 Zeichen. Wird zur Anzeige im Dashboard gespeichert. Ein Pfad mit / oder \ wird abgelehnt.
​
string
ID, die Sie als fileId oder logoOptions.fileId übergeben.
​
string
Vorsignierte URL, an die Sie die Datei per PUT senden.
​
integer
Sekunden, bis uploadUrl abläuft: 600.
​
string
HTTP-Methode für den Upload: PUT.

​
Häufige Probleme

Der Content-Type passt nicht zum Target. Zum Beispiel akzeptiert pdf nur application/pdf. Siehe Limits.
Senden Sie den Content-Type in Kleinbuchstaben und ohne Parameter: image/png, nicht Image/PNG oder image/png; charset=utf-8.
Die angegebene size liegt über dem Limit für das Target. Komprimieren Sie die Datei, bevor Sie sie registrieren.
Die URL läuft 10 Minuten nach der Registrierung der Datei ab, und die Anfrage muss genau den registrierten Content-Type und die registrierte Content-Length senden. Registrieren Sie die Datei erneut, um eine neue URL zu erhalten.
Sie haben die Datei registriert, aber der PUT an uploadUrl wurde nicht abgeschlossen. Laden Sie die Datei hoch und erstellen Sie dann den QR-Code.
Die Datei wurde mit einem anderen Target registriert, zum Beispiel eine image-Datei für einen pdf-QR-Code. Registrieren Sie einen neuen Upload mit dem passenden Target.
Die fileId existiert nicht. Nehmen Sie sie aus der Antwort von Datei-Upload registrieren.

​
Wie geht es weiter?

QR-Codes

QR-Typen

Anpassung

Fehler