API nuoroda
API nuoroda
qr3.app REST API yra pasiekiama adresu https://qr3.app/v1/ ir visiškai atitinka konvencijas, aprašytas API apžvalgoje (autentifikavimas naudojant Authorization: Bearer, klaidos pagal RFC 7807, puslapiavimas naudojant žymeklį).
Pradžia
API apžvalga Versijų valdymas, užklausų / atsakymų formatas, idempotentiškumas, puslapiavimas.
Autentifikavimas API raktai, Workspace antraštės, testavimo ir gamybinė aplinkos.
Klaidų žinynas RFC 7807 klaidų tipai su būsenos kodais ir pavyzdžiais.
Interaktyvi nuoroda OpenAPI 3.1 + Scalar bandomoji aplinka – įveskite žetonus ir iškart išbandykite.
Išteklių sritys
QR kodai Dinaminių ir statinių kodų kūrimas, atnaujinimas, sekimas ir saugus nukreipimas.
Organizacijos ir Workspaces Paskyros, Workspaces, narystės ir planų apribojimai.
Webhooks Įvykių prenumerata, parašo patvirtinimas, pristatymo žurnalai.
MCP ir agentai Model Context Protocol – QR kodų ir DPP kūrimas naudojant AI agentus.
Duomenų apsauga ir privatumo pabaigos taškai BDAR eksportas, paskyrų trynimas, IP maiša, sutikimai.
Versijų valdymas ir pasenimas Kaip įvedami nauji laukai ir kas sukelia kritinius pakeitimus.
DPP specifiniai pabaigos taškai
Visi Digital Product Passport pabaigos taškai yra dokumentuoti atskiroje skiltyje Digital Product Passport – įskaitant baterijų ir tekstilės schemų nuorodas, ES atitikties tikrinimo įrankį bei viešąjį GS1 sprendiklį.
Baziniai URL pagal aplinką
| Aplinka | Bazinis URL | Paskirtis |
|---|---|---|
| Production | https://qr3.app/v1/ | Vieša tiesioginė API |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Priešgamybinė bandomoji aplinka (žr. ENVIRONMENTS.md) |
| Lokalus | http://localhost:8787/v1/ | pnpm --filter api dev |
OpenAPI specifikacija pateikiama adresu https://qr3.app/v1/openapi.json ir yra automatiškai atnaujinama kiekvieno įdiegimo metu.