REST-API-Quickstart
- 1
API-Key erstellen
Im Dashboard: Einstellungen → API-Keys → Neuer Key. Der Klartext-Key wird genau einmal angezeigt und danach nie wieder gespeichert — erhalten bleiben nur ein HMAC-SHA-256-Hash und ein kurzes Anzeige-Präfix. Format: `qrs_live_<64 Hex-Zeichen>`; als `QCS_API_KEY` ablegen. Scopes werden beim Erstellen gewählt: `qrcodes:read`, `qrcodes:write`, `scans:read`, `conversions:write`. Das Formular wählt die beiden Lese-Scopes vor — der umsichtige Standard für ein Credential, das in einem CI-Job landet. API-Zugriff ist ein Business-Plan-Feature; ein Key auf einem niedrigeren Plan authentifiziert sich, erhält aber 403 `plan_limit`. Jeder Key ist auf 300 Requests pro Minute begrenzt.
- 2
Dynamischen QR-Code anlegen
POST an `/api/v1/qrcodes` mit Header `Authorization: Bearer $QCS_API_KEY` und Body `{"name": "Frühjahrsflyer", "type": "url", "destination_url": "https://example.com/landing"}`. Die Antwort `{"data": {…}}` liefert die QR-ID, den erzeugten Slug und `scan_url` — die getrackte `/q/{slug}`-Adresse, die der gedruckte Code kodiert. `status` akzeptiert `draft`, `active` oder `paused`, `campaign_id` hängt den Code an eine bestehende Kampagne. Ist das Kontingent an dynamischen QR-Codes aufgebraucht, antwortet der Aufruf mit 403 `plan_limit` samt `details.limit` und `details.current` statt eines generischen Fehlers. Statische Typen verbrauchen dieses Kontingent nie.
- 3
Scan-Events lesen
GET `/api/v1/scans?qr_id={id}&days=30&per_page=50` liefert eine Seite Scan-Events plus einen `pagination`-Block. Jedes Event trägt `device_type`, `os`, `browser`, `country`, `region`, `city`, `language`, `referrer`, `is_bot`, `ab_variant` und das `destination`, an das der Besucher geschickt wurde. `days` akzeptiert 1–365, Standard ist 30. IP-Adressen stehen nicht in der Antwort, weil die Plattform sie nicht speichert: in die Datenbank gelangt nur ein Keyed Hash. Ohne `qr_id` werden alle Scans des Workspace gelesen.
- 4
Ziel ändern
PATCH `/api/v1/qrcodes/{id}` mit Body `{"destination_url": "https://example.com/new-destination"}`. Derselbe Endpoint akzeptiert `name`, `payload`, `campaign_id` und `status` mit `draft`, `active`, `paused` oder `archived`; mindestens ein Feld ist erforderlich. Er antwortet 200 mit dem aktualisierten Record. Der gedruckte Code löst schon beim nächsten Scan auf das neue Ziel auf — kein Nachdruck, kein Cache-Flush. `DELETE /api/v1/qrcodes/{id}` antwortet 204 und zieht den Code zurück.
- 5
Conversion serverseitig erfassen
POST `/api/v1/conversions` mit Body `{"event_name": "purchase", "external_id": "order-1042", "amount": 49.9, "currency": "EUR", "qr_slug": "fruehjahrsflyer"}`. Ein neues Event antwortet 201 `{"id": …, "created": true}`; dieselbe `external_id` erneut gesendet antwortet 200 `{"duplicate": true}`, sodass ein wiederholender Job den Umsatz nicht doppelt zählt. Die Attribution akzeptiert `qr_slug` oder den auf der Landingpage erfassten `session_ref`-Wert. Der Aufruf benötigt den Scope `conversions:write`.
- 6
Fehler — und wo das WordPress-Plugin steht
Jeder Fehlschlag liefert `{"error": {"code": …, "message": …}}` mit einem stabilen Code zum Verzweigen: `unauthorized`, `insufficient_scope`, `plan_limit`, `validation_error`, `not_found`, `rate_limited`. Validierungsfehler ergänzen `details.issues`, nach Feld indiziert. Das WordPress-Plugin ist ein Konnektor, keine zweite API: Es synchronisiert über `/api/v1/wp/*` mit seinem Lizenzschlüssel in denselben Workspace, sodass in WordPress erstellte Codes in derselben `GET /api/v1/qrcodes`-Liste erscheinen wie hier erstellte. Das Plugin ist für die API nicht nötig, und die API nicht für das Plugin.
Häufig gestellte Fragen
Was ist QRCode Suite?
QRCode Suite ist eine eigenständige QR-Plattform: Erstellen Sie ein kostenloses Konto und generieren Sie markenkonforme dynamische QR-Codes im Browser — ganz ohne WordPress. Connectoren bringen dieselben Codes zu WordPress und WooCommerce, wo Bestellungen einzelnen QR-Codes zugeordnet werden können.
Funktioniert QRCode Suite ohne WordPress?
Ja. QRCode Suite ist ein eigenständiges SaaS: registrieren, QR-Codes erstellen und Scans verfolgen — alles auf qrcode-suite.com. Das WordPress-Plugin ist ein optionaler Connector, der Ihre Codes in wp-admin bringt und die WooCommerce-Bestell-Attribution ergänzt.
Benötigt QRCode Suite ein separates Abonnement?
Der Free-Plan ist kostenlos verfügbar — ohne Kreditkarte. Bezahlpläne (Pro 9 €, Business 29 €, Agency 79 € pro Monat) schalten unbegrenzte Codes, Redirect-Regeln und mehr frei. Es gibt keine Gebühr pro Scan.
Welche QR-Code-Typen unterstützt QRCode Suite?
QRCode Suite unterstützt 22 QR-Code-Typen: Statische URL, Dynamische URL, Klartext, Telefon, E-Mail, Standort, Link Hub, SMS, WhatsApp, Wi-Fi, vCard, Social-Profil, PDF, Datei-Download, App-Download, Coupon, Kalender-Event, Lead-Formular, Bewertungserfassung, Großhandelsanfrage, Treueprämie und Custom Payload.
Kann ich das Ziel eines QR-Codes nach dem Druck ändern?
Ja. Dynamische QR-Codes nutzen eine kurze Weiterleitungs-URL. Sie können das Ziel jederzeit aus Ihrem Dashboard heraus aktualisieren, ohne den Code neu zu erstellen oder zu drucken.
Hilfe beim Einstieg?
Starten Sie kostenlos oder durchsuchen Sie die Dokumentation.