Referenza tal-API
Referenza tal-API
Ir-REST API ta’ qr3.app hija aċċessibbli fuq https://qr3.app/v1/ u ssegwi b’mod konsistenti l-konvenzjonijiet mill-Ħarsa Ġenerali tal-API (awtentikazzjoni permezz ta’ Authorization: Bearer, żbalji skont RFC 7807, paginazzjoni bil-cursor).
Bidu
Ħarsa Ġenerali tal-API Verżjonar, format ta' talba/rispons, idempotenza, paginazzjoni.
Awtentikazzjoni API keys, headers tal-workspace, ambjent ta' test vs. live.
Referenza tal-Iżbalji Tipi ta' żbalji RFC 7807 b'kodiċijiet tal-istatus u eżempji.
Referenza Interattiva OpenAPI 3.1 + Scalar-Playground — daħħal it-tokens u ttestja direttament.
Żoni tar-Riżorsi
QR Codes Ħolqien, aġġornament, traċċar u ridirezzjonar sigur ta' codes dinamiċi u statiċi.
Organizzazzjonijiet u Workspaces Kontijiet, workspaces, sħubijiet u limiti tal-pjanijiet.
Webhooks Abbonament għal avvenimenti, verifika tal-firem, reġistri tal-kunsinna.
MCP u Agents Model Context Protocol — ħolqien ta' QR codes u DPPs minn AI agents.
Protezzjoni tad-Data u Endpoints tal-Privatezza Esportazzjoni tal-GDPR, tħassir ta' kontijiet, hashing tal-IP, kunsensi.
Verżjonar u Deprecation Kif jiġu introdotti oqsma ġodda u x'jikkawża bidliet li jkissru l-kompatibbiltà.
Endpoints Speċifiċi għad-DPP
L-endpoints kollha tal-passaport diġitali tal-prodott huma ddokumentati fit-taqsima tagħhom stess Digital Product Passport — inklużi referenzi tal-iskemi għall-batteriji u t-tessuti, il-validatur tal-konformità tal-UE kif ukoll ir-resolver pubbliku tal-GS1.
URLs Bażi għal kull Ambjent
| Ambjent | URL Bażi | Għan |
|---|---|---|
| Production | https://qr3.app/v1/ | API pubblika live |
| Stage | https://qr3-api-stage.<account>.workers.dev/v1/ | Pilota ta’ qabel il-produzzjoni (ara ENVIRONMENTS.md) |
| Lokali | http://localhost:8787/v1/ | pnpm --filter api dev |
L-ispeċifikazzjoni tal-OpenAPI tinsab fuq https://qr3.app/v1/openapi.json u tiġi aġġornata awtomatikament ma’ kull deploy.