Přehled API

REST API qr3.app je dostupná na adrese https://qr3.app/v1/.

Verzování

API je verzována prostřednictvím cesty v URL (/v1/). Změny způsobující nekompatibilitu (breaking changes) vždy vedou k nové hlavní verzi.

Formát požadavku

Content-Type: application/json
Autentizace: Authorization: Bearer qr3_sk_xxx
Idempotence: POST požadavky lze učinit idempotentními pomocí Idempotency-Key: <uuid>

Formát odpovědi

Všechny úspěšné odpovědi vrací JSON:

{
  "id": "qr_abc123",
  "type": "url",
  "url": "https://example.com",
  "short_url": "https://qr3.app/r7f3Kx",
  "created_at": "2026-03-15T10:00:00.000Z"
}

Odpovědi obsahující seznamy mají vždy strukturu meta.pagination:

{
  "data": [...],
  "meta": {
    "request_id": "req_xxx",
    "pagination": {
      "has_more": true,
      "next_cursor": "qr_abc",
      "total_count": 142
    }
  }
}

Formát chyb (RFC 7807)

Všechny chyby se řídí standardem RFC 7807 Problem Details:

{
  "type": "https://docs.qr3.app/errors/not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "QR code qr_xxx not found",
  "instance": "/v1/codes/qr_xxx"
}

Status	Typ chyby	Popis
400	`bad-request`	Neplatný JSON nebo chybějící povinná pole
401	`authentication`	Chybějící nebo neplatný API klíč
403	`forbidden`	Chybí oprávnění k tomuto prostředku
404	`not-found`	Prostředek nebyl nalezen
409	`conflict`	Konflikt Idempotency-Key
422	`validation-error`	Chybná vstupní data (s polem `errors`)
429	`rate-limited`	Překročen limit požadavků (Rate-Limit)
500	`internal`	Interní chyba serveru

Stránkování

API používá stránkování založené na kurzoru (Cursor-based pagination):

# Erste Seite
GET /v1/codes?limit=20

# Nächste Seite
GET /v1/codes?limit=20&cursor=qr_lastid

Limity požadavků (Rate Limits)

Každá odpověď obsahuje:

X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
X-RateLimit-Reset: 1742040120

Interaktivní reference API

Otestujte všechny koncové body přímo v prohlížeči:

→ Otevřít referenci API (Scalar, interaktivní, s možností vyzkoušení Try-it-out)

DPP-Contract (Fáze 4a)

Pro workflow baterií dokumentuje qr3.app navíc tyto trasy:

POST /v1/dpp
GET /v1/dpp
GET /v1/dpp/:id
POST /v1/dpp/validate
GET /v1/dpp/:id/qr.svg
GET /v1/dpp/:id/qr.png
GET /v1/dpp/:id/qr.pdf
GET /v1/dpp/:id/qr.eps
GET /01/...
GET /dpp/:gtin/:serial?lot=...

Stránky nástěnky (Dashboard), SDK a tato dokumentace používají stejný datový kontrakt.