API viited
API viited
qr3.app REST-API on kättesaadav aadressil https://qr3.app/v1/ ja järgib läbivalt konventsioone, mis on toodud API ülevaates (autentimine päisega Authorization: Bearer, vead vastavalt RFC 7807 standardile, kursor-pagineerimine).
Alustamine
API ülevaade Versioonihaldus, päringu/vastuse vorming, idempotentsus, pagineerimine.
Autentimine API-võtmed, töölaua (Workspace) päised, testi- vs. tootmiskeskkond.
Vigade viited RFC 7807 veatüübid koos olekukoodide ja näidetega.
Interaktiivne viide OpenAPI 3.1 + Scalar mänguväljak — sisesta märgid (tokens) ja testi otse.
Ressursside valdkonnad
QR-koodid Dünaamiliste ja staatiliste koodide loomine, värskendamine, jälgimine ja turvaline ümbersuunamine.
Organisatsioonid ja töölauad Kontod, töölauad (Workspaces), liikmelisused ja paketi piirangud.
Webhooks Sündmuste tellimine, allkirja verifitseerimine, tarne logid.
MCP & Agents Model Context Protocol — QR-koodide ja DPP-de loomine tehisintellekti agentidest (AI-Agents).
Andmekaitse ja privaatsuse lõpp-punktid GDPR-eksport, kontode kustutamine, IP-räsamine, nõusolekud.
Versioonihaldus ja kasutuselt kõrvaldamine Kuidas uusi välju kasutusele võetakse ja mis põhjustab rikkuvaid muudatusi (breaking changes).
DPP-spetsiifilised lõpp-punktid
Kõik Digital-Product-Passport-i lõpp-punktid on dokumenteeritud eraldi jaotises Digital Product Passport — sealhulgas aku ja tekstiili skeemiviited, EL-i vastavuse validaator ning avalik GS1-lahendaja (resolver).
Baas-URL-id keskkondade kaupa
| Keskkond | Baas-URL | Eesmärk |
|---|---|---|
| Production | https://qr3.app/v1/ | Avalik live-API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Tootmiseelne piloot (vt ENVIRONMENTS.md) |
| Kohalik | http://localhost:8787/v1/ | pnpm --filter api dev |
OpenAPI spetsifikatsioon asub aadressil https://qr3.app/v1/openapi.json ja seda värskendatakse automaatselt iga paigalduse (deploy) käigus.