QR Suisse API: Dokumentation der REST-API
QR Suisse bietet eine REST-API, mit der Sie Ihre dynamischen QR-Codes per Programmierung erstellen, lesen, bearbeiten, archivieren und löschen, sie in Ihrer Liste suchen, ihr Bild (PNG oder SVG) herunterladen sowie deren Scan-Statistiken abrufen können. Sie lässt sich in Ihre bestehenden Tools integrieren — Zapier, Make, ein CRM, ein internes Skript — überall, wo eine HTTPS-Anfrage ausreicht.
Die API ist mit den Plänen Pro und Entreprise verfügbar. Der Pro-Plan umfasst 5 QR-Code-Erstellungen über die API pro Monat und 1 API-Schlüssel; der Entreprise-Plan umfasst 100 Erstellungen pro Monat und bis zu 10 gleichzeitig aktive API-Schlüssel. Bei beiden Plänen können optional API-Erstellungspakete gekauft werden. Die Schlüssel verwalten Sie im Dashboard. Details zu den Plänen und Paketen finden Sie auf unserer Preisseite.
Schlüssel erstellen, Rechte wählen, rotieren oder widerrufen: Die Hilfeseite Ihre API-Schlüssel verwalten erklärt alles, auch die Kontingente, das Einfrieren im Gratis-Plan und das Rate-Limit.
Aktuelle Version der API: 1.1.1. Die Neuerungen jeder Version und unsere Zusage zur Kompatibilität finden Sie im Abschnitt Versionsverlauf der Referenz unten.
OpenAPI-Spezifikation herunterladen
Erste Schritte
- Wechseln Sie zum Pro- oder Entreprise-Plan, falls noch nicht geschehen.
- Erstellen Sie einen API-Schlüssel in Ihrem Dashboard und wählen Sie die benötigten Rechte (Lesen, Erstellen, Bearbeiten, Löschen, Statistiken).
- Authentifizieren Sie jede Anfrage mit dem Header Authorization: Bearer <Schlüssel>.
- Sehen Sie sich die vollständige Endpoint-Referenz unten an.
Häufig gestellte Fragen
Welche Pläne bieten Zugang zur API?
Die Pläne Pro und Entreprise, ohne Zusatzkosten. Der Pro-Plan umfasst 5 QR-Code-Erstellungen über die API pro Monat und 1 API-Schlüssel; der Entreprise-Plan umfasst 100 Erstellungen pro Monat und bis zu 10 gleichzeitig aktive API-Schlüssel. Der Gratis-Plan bietet keinen API-Zugang.
Welche Operationen ermöglicht die API heute?
Erstellen, Lesen, Bearbeiten, Archivieren (und Reaktivieren) und Löschen von QR-Codes (Typen URL und Visitenkarte), das Durchsuchen, Filtern und Sortieren ihrer Liste, das Herunterladen ihres Bildes (PNG oder SVG), das Abrufen ihrer Scan-Statistiken sowie das Abrufen des verbleibenden Erstellungskontingents. Eine durch einen Netzwerkunterbruch unterbrochene Erstellung lässt sich mit dem Header Idempotency-Key ohne Duplikat erneut senden. Die Verwaltung bereits bestehender QR-Codes (Lesen, Bearbeiten, Archivieren, Löschen, Herunterladen des Bildes, Statistiken) unterliegt keinem Kontingent.
Kann ich die API mit einem Automaten oder einem KI-Agenten verbinden?
Die API ist eine mit einem Schlüssel authentifizierte Standard-REST-API — sie kann von jedem Tool aufgerufen werden, das HTTPS-Anfragen senden kann, einschliesslich Zapier oder Make, oder von einem Agenten, der diese Endpoints direkt abfragt. Ein dediziertes Verbindungsstück für KI-Assistenten (MCP) ist derzeit nicht verfügbar.
Gibt es eine Begrenzung der Anzahl Aufrufe oder Erstellungen?
Ja, zwei. Ein Rate-Limit schützt den Dienst: 30 Anfragen pro Minute und Schlüssel, davon höchstens 8 Erstellungen, und 10 PNG-Bilder pro Minute für das ganze Konto; darüber hinaus antwortet die API mit 429 rate_limited und der Wartezeit. Zudem unterliegt nur die Erstellung von QR-Codes über die API einem monatlichen Kontingent: 5 Erstellungen pro Kalendermonat mit dem Pro-Plan, 100 mit dem Entreprise-Plan, nicht auf den Folgemonat übertragbar. Reicht dieses Kontingent nicht aus, kommen API-Erstellungspakete hinzu (Einmalkauf, ohne Rückerstattung, aktives Pro- oder Entreprise-Abonnement erforderlich). Lesen, Bearbeiten, Archivieren, Löschen, das Herunterladen der Bilder und das Abrufen von Statistiken verbrauchen dieses Kontingent nicht. Ihr Tool kann die Erstellungen des Monats und das verbleibende Guthaben jederzeit mit GET /usage abrufen.
Was die API kann, was das Dashboard kann
Die API und das Dashboard arbeiten mit denselben QR-Codes, decken aber nicht dieselben Vorgänge ab. Die folgende Tabelle beschreibt, was heute verfügbar ist. Die API ist den Plänen Pro und Entreprise vorbehalten. Das Dashboard steht in allen Plänen zur Verfügung; Funktionen, die den Plänen Pro und Entreprise vorbehalten sind, sind gekennzeichnet.
| Vorgang | API | Dashboard |
|---|---|---|
| Link-QR-Code erstellen | Ja. Für eine E-Mail, ein Telefon, eine SMS oder einen FTP-Server senden Sie die vollständige Adresse (mailto:, tel:, sms:, ftp://). | Ja, mit Assistenten: vorausgefüllter Betreff und Text, UTM-Parameter. |
| Visitenkarte erstellen | Ja. | Ja. |
| QR Kalender erstellen | Nicht dokumentiert: Die API hat weder Felder für einen Termin (Titel, Zeiten, Ort) noch einen eigenen Endpunkt. Erstellen Sie QR Kalender im Dashboard. | Ja. |
| Ziel, Bezeichnung oder Visitenkarte ändern | Ja. Eine Visitenkarte lässt sich teilweise ändern: Nicht gesendete Felder bleiben unverändert. | Ja, auf der Seite des QR-Codes. |
| Archivieren oder reaktivieren | Ja, ein QR-Code nach dem anderen, mit dem Feld active der Bearbeitung. Weder das Archivieren noch das Reaktivieren wird an das Erstellungskontingent angerechnet. | Ja, QR-Code für QR-Code oder bis zu 100 auf einmal (Pro und Entreprise). |
| Endgültig löschen | Ja. | Ja, QR-Code für QR-Code. |
| QR-Codes auflisten | Ja, Seite für Seite, mit Suche in Bezeichnung, Ziel und Ende der kurzen Adresse, Filtern (aktiv oder archiviert, Typ, Erstellungszeitraum) und Sortierung (Erstellungsdatum, Bezeichnung). Weder Filter nach Ersteller oder Etiketten noch Sortierung nach Anzahl Scans. | Ja, mit Suche, Filtern (Status, Typ, Ersteller, Etiketten) und Sortierung. |
| Etiketten | Nein. | Ja (Pro und Entreprise). |
| Gruppenaktionen, ZIP-Download, CSV-Export | Nein. Bilder werden einzeln heruntergeladen. | Ja, bis zu 100 QR-Codes auf einmal (Pro und Entreprise). |
| Bild als PNG oder SVG herunterladen | Ja. PNG mit 128 bis 1024 Pixel Seitenlänge, nach Wahl. | Ja. |
| Scan-Statistiken | Gesamtzahl und Scans pro Tag eines QR-Codes, über 15 Monate, ohne Wahl des Zeitraums. | Verlauf jedes QR-Codes und Seite Statistiken, filterbar nach QR-Code und Zeitraum. Verlauf: 7 Tage im Gratis-Plan, 15 Monate mit Pro und Entreprise. |
| Adresse mit Ihrer eigenen Domain | Ja: Ist Ihre Domain aktiv, verwenden die von der API gelieferte Adresse und das Bild diese Domain. | Ja, einschliesslich Einrichtung (Pro und Entreprise). |
| Die API-Erstellungen des Monats verfolgen | Ja, mit GET /usage (Recht QR_CREATE): Erstellungen des Monats, monatliches Kontingent, verbleibende Guthaben in Ihren Paketen und Datum der Zurücksetzung. Eine abgelehnte Erstellung liefert zudem 429 quota_exceeded mit dem Datum der Zurücksetzung. | Ja, im Bildschirm API-Schlüssel (Berechtigung «Verwalter der API-Schlüssel» oder Administrator). |
| API-Schlüssel, Mitglieder und Berechtigungen, Abonnement, Kauf von Paketen | Nein. | Ja, je nach Plan und Ihren Berechtigungen. |
- Im Dashboard wird der Typ eines QR-Codes (Link, Visitenkarte oder Kalender) bei der Erstellung festgelegt. Über die API lässt sich das Ziel eines Link- oder Kalender-QR-Codes durch jede akzeptierte Adresse ersetzen: So kann ein Kalender zu einem Link werden und umgekehrt. Eine Visitenkarte bleibt eine Visitenkarte. Auf beiden Wegen ändert sich die im Bild codierte kurze Adresse nie.
- Weder die API noch das Dashboard senden automatische Benachrichtigungen (Webhooks), zum Beispiel bei einem Scan oder wenn das Kontingent erreicht ist.
- Um eine Erstellung, die durch eine Zeitüberschreitung oder einen Netzwerkunterbruch unterbrochen wurde, ohne Duplikat erneut zu senden, verwenden Sie den Header Idempotency-Key (ein Zufallswert pro Erstellung, UUID v4 empfohlen): Mit demselben Idempotency-Key-Wert und demselben Inhalt innerhalb von 24 Stunden erneut gesendet, gibt sie den bereits erstellten QR-Code zurück, ohne einen zweiten zu erstellen oder eine weitere Erstellung des Kontingents zu verbrauchen. Ohne diesen Header prüfen Sie die Liste Ihrer QR-Codes, bevor Sie die Anfrage erneut senden: Eine erfolgreiche Erstellung bleibt auf das Kontingent angerechnet, auch wenn Sie den doppelten QR-Code danach löschen.