API-viite
API-viite
qr3.app REST-API on saavutettavissa osoitteessa https://qr3.app/v1/ ja se noudattaa johdonmukaisesti API-yleiskatsauksen käytäntöjä (todennus Authorization: Bearer -otsikolla, RFC 7807 -standardin mukaiset virheet, Cursor-sivutus).
Aloitus
API-yleiskatsaus Versiointi, pyyntö-/vastausmuoto, idempotenssi, sivutus.
Todennus API-avaimet, Workspace-otsikot, testi- vs. tuotantoympäristö.
Virheviite RFC 7807 -virhetyypit tilakoodeineen ja esimerkkeineen.
Interaktiivinen viite OpenAPI 3.1 + Scalar-Playground — syötä tunnukset ja testaa suoraan.
Resurssialueet
QR-koodit Luo, päivitä, seuraa ja ohjaa turvallisesti dynaamisia ja staattisia koodeja.
Organisaatiot & työtilat Tilit, työtilat, jäsenyydet ja tilausrajat.
Webhooks Tapahtumien tilaus, allekirjoituksen varmennus, toimituslokit.
MCP & Agents Model Context Protocol — luo QR-koodeja ja DPP-passeja tekoälyagenteista.
Tietosuoja & Privacy-päätepisteet GDPR-vienti, tilien poistaminen, IP-hajautus, suostumukset.
Versiointi & käytöstä poistaminen Miten uusia kenttiä otetaan käyttöön ja mikä aiheuttaa rikkovia muutoksia.
DPP-kohtaiset päätepisteet
Kaikki Digital Product Passport -päätepisteet on dokumentoitu omassa osiossaan Digital Product Passport — mukaan lukien akku- ja tekstiiliskeemaviitteet, EU-vaatimustenmukaisuuden validointityökalu sekä julkinen GS1-selvitin.
Perus-URL-osoitteet ympäristöittäin
| Ympäristö | Perus-URL | Käyttötarkoitus |
|---|---|---|
| Production | https://qr3.app/v1/ | Julkinen live-API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pre-production-pilotti (katso ENVIRONMENTS.md) |
| Paikallinen | http://localhost:8787/v1/ | pnpm --filter api dev |
OpenAPI-määritys on saatavilla osoitteessa https://qr3.app/v1/openapi.json ja se päivitetään automaattisesti jokaisen julkaisun yhteydessä.