API-referencia
API-referencia
A qr3.app REST API a https://qr3.app/v1/ címen érhető el, és teljes mértékben követi az API-áttekintésben leírt konvenciókat (hitelesítés Authorization: Bearer használatával, RFC 7807 szerinti hibák, kurzor-alapú lapozás).
Kezdő lépések
API-áttekintés Verziókezelés, kérés/válasz formátum, idempotencia, lapozás.
Hitelesítés API-kulcsok, Workspace-fejlécek, teszt vs. éles környezet.
Hiba-referencia RFC 7807 hibatípusok státuszkódokkal és példákkal.
Interaktív referencia OpenAPI 3.1 + Scalar-Playground — tokenek megadása és közvetlen tesztelés.
Erőforrás-területek
QR-kódok Dinamikus és statikus kódok létrehozása, frissítése, követése és biztonságos átirányítása.
Szervezetek és Workspace-ek Fiókok, Workspace-ek, tagságok és csomaglimitek.
Webhookok Események feliratkozása, aláírás-ellenőrzés, kézbesítési naplók.
MCP & Agents Model Context Protocol — QR-kódok és DPP-k generálása AI-Agentekből.
Adatvédelem és Privacy-végpontok GDPR-exportálás, fióktörlés, IP-hashelés, hozzájárulások.
Verziókezelés és elavulás Hogyan vezetünk be új mezőket, és mi számít breaking change-nek.
DPP-specifikus végpontok
Minden Digital-Product-Passport-végpont a saját Digital Product Passport szekcióban van dokumentálva — beleértve az akkumulátorokra és textilekre vonatkozó sémareferenciákat, az EU-megfelelőségi ellenőrzőt (compliance validator), valamint a nyilvános GS1-resolvert.
Bázis URL-ek környezetenként
| Környezet | Bázis URL | Cél |
|---|---|---|
| Production | https://qr3.app/v1/ | Nyilvános éles API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pre-production pilot (lásd: ENVIRONMENTS.md) |
| Helyi | http://localhost:8787/v1/ | pnpm --filter api dev |
Az OpenAPI-specifikáció a https://qr3.app/v1/openapi.json címen található, és minden telepítéskor (deploy) automatikusan frissül.