API-Referenz
API-Referenz
Die qr3.app REST-API ist unter https://qr3.app/v1/ erreichbar und folgt durchgehend den Konventionen aus der API-Übersicht (Authentifizierung via Authorization: Bearer, Fehler nach RFC 7807, Cursor-Pagination).
Einstieg
API-Übersicht Versionierung, Request-/Response-Format, Idempotenz, Pagination.
Authentifizierung API-Keys, Workspace-Header, Test- vs. Live-Umgebung.
Fehler-Referenz RFC 7807-Fehlertypen mit Status-Codes und Beispielen.
Interaktive Referenz OpenAPI 3.1 + Scalar-Playground — Tokens eintragen und direkt testen.
Ressourcen-Bereiche
QR-Codes Dynamische & statische Codes anlegen, aktualisieren, tracken und sicher umleiten.
Organisationen & Workspaces Accounts, Workspaces, Mitgliedschaften und Plan-Limits.
Webhooks Events abonnieren, Signatur-Verifikation, Delivery-Logs.
MCP & Agents Model Context Protocol — QR-Codes und DPPs aus AI-Agents erzeugen.
Datenschutz & Privacy-Endpoints DSGVO-Export, Löschkonten, IP-Hashing, Consents.
Versionierung & Deprecation Wie neue Felder eingeführt werden und was Breaking Changes auslöst.
DPP-spezifische Endpoints
Alle Digital-Product-Passport-Endpoints sind im eigenen Bereich Digital Product Passport dokumentiert — inklusive Schema-Referenzen für Batterie und Textil, EU-Compliance-Validator sowie dem öffentlichen GS1-Resolver.
Basis-URLs pro Umgebung
| Umgebung | Basis-URL | Zweck |
|---|---|---|
| Production | https://qr3.app/v1/ | Öffentliche Live-API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pre-Production-Pilot (siehe ENVIRONMENTS.md) |
| Lokal | http://localhost:8787/v1/ | pnpm --filter api dev |
Die OpenAPI-Spezifikation liegt unter https://qr3.app/v1/openapi.json und wird bei jedem Deploy automatisch aktualisiert.