API reference
API reference
REST API qr3.app je dostupné na adrese https://qr3.app/v1/ a důsledně se řídí konvencemi z Přehledu API (autentizace pomocí Authorization: Bearer, chyby podle RFC 7807, stránkování pomocí kurzoru).
Začínáme
Přehled API Verzování, formát požadavků/odpovědí, idempotence, stránkování.
Autentizace API klíče, hlavičky pracovního prostoru, testovací vs. produkční prostředí.
Referenční příručka chyb Chybové typy podle RFC 7807 se stavovými kódy a příklady.
Interaktivní reference OpenAPI 3.1 + Scalar Playground — zadejte tokeny a rovnou testujte.
Oblasti prostředků
QR kódy Vytváření, aktualizace, sledování a bezpečné přesměrování dynamických a statických kódů.
Organizace a pracovní prostory Účty, pracovní prostory, členství a limity tarifů.
Webhooks Přihlášení k odběru událostí, ověřování podpisů, protokoly o doručení.
MCP & Agents Model Context Protocol — generování QR kódů a DPP z AI agentů.
Ochrana osobních údajů a koncové body soukromí Export podle GDPR, mazání účtů, hashování IP adres, souhlasy.
Verzování a zastarávání Jak jsou zaváděna nová pole a co způsobuje breaking changes.
Koncové body specifické pro DPP
Všechny koncové body pro digitální pasy produktů jsou zdokumentovány ve vlastní sekci Digital Product Passport — včetně referenčních schémat pro baterie a textil, validátoru shody s předpisy EU a veřejného GS1 resolveru.
Základní URL pro jednotlivá prostředí
| Prostředí | Základní URL | Účel |
|---|---|---|
| Production | https://qr3.app/v1/ | Veřejné produkční API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Předprodukční pilotní prostředí (viz ENVIRONMENTS.md) |
| Lokální | http://localhost:8787/v1/ | pnpm --filter api dev |
Specifikace OpenAPI je k dispozici na adrese https://qr3.app/v1/openapi.json a je automaticky aktualizována při každém nasazení.