Referencja API

REST API qr3.app jest dostępne pod adresem https://qr3.app/v1/ i konsekwentnie przestrzega konwencji opisanych w Przeglądzie API (uwierzytelnianie za pomocą Authorization: Bearer, błędy zgodne z RFC 7807, stronicowanie typu cursor).

Wprowadzenie

Przegląd API Wersjonowanie, format żądań/odpowiedzi, idempotentność, stronicowanie.

Uwierzytelnianie Klucze API, nagłówki Workspace, środowisko testowe vs. produkcyjne.

Referencja błędów Typy błędów RFC 7807 z kodami statusu i przykładami.

Interaktywna referencja OpenAPI 3.1 + Scalar-Playground — wprowadź tokeny i testuj bezpośrednio.

Obszary zasobów

Kody QR Tworzenie, aktualizowanie, śledzenie i bezpieczne przekierowywanie kodów dynamicznych i statycznych.

Organizacje i Workspaces Konta, Workspaces, członkostwa i limity planów.

Webhooks Subskrypcja zdarzeń, weryfikacja sygnatur, logi dostarczenia.

MCP i agenci Model Context Protocol — generowanie kodów QR i DPP z agentów AI.

Ochrona danych i endpointy prywatności Eksport RODO, usuwanie kont, haszowanie IP, zgody (consents).

Wersjonowanie i wycofywanie (Deprecation) Jak wprowadzane są nowe pola i co powoduje zmiany przełamujące (breaking changes).

Endpointy specyficzne dla DPP

Wszystkie endpointy paszportu produktu (Digital Product Passport) są udokumentowane w dedykowanej sekcji Digital Product Passport — w tym referencje schematów dla baterii i tekstyliów, walidator zgodności z UE oraz publiczny resolver GS1.

Bazowe adresy URL dla środowisk

Środowisko	Bazowy URL	Cel
Production	`https://qr3.app/v1/`	Publiczne produkcyjne API
Stage	`https://qr3-api-stage.<account>.workers.dev/v1/`	Pilotaż przedprodukcyjny (patrz `ENVIRONMENTS.md`)
Lokalne	`http://localhost:8787/v1/`	`pnpm --filter api dev`

Specyfikacja OpenAPI jest dostępna pod adresem https://qr3.app/v1/openapi.json i jest automatycznie aktualizowana przy każdym wdrożeniu.