Pregled API-ja

REST API za qr3.app je dostopen na naslovu https://qr3.app/v1/.

Različice

API je verzioniran prek poti URL (/v1/). Prelomne spremembe (breaking changes) vedno vodijo do nove glavne različice.

Format zahtevka

Content-Type: application/json
Avtentikacija: Authorization: Bearer qr3_sk_xxx
Idempotenca: Zahtevke POST je mogoče narediti idempotentne z glavo Idempotency-Key: <uuid>

Format odgovora

Vsi uspešni odgovori vračajo JSON:

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

Odgovori s seznami imajo vedno strukturo meta.pagination:

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

Oblika napak (RFC 7807)

Vse napake sledijo standardu 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	Vrsta napake	Opis
400	`bad-request`	Neveljaven JSON ali manjkajoča obvezna polja
401	`authentication`	Manjkajoč ali neveljaven API-ključ
403	`forbidden`	Nimate dovoljenja za ta vir
404	`not-found`	Vir ni najden
409	`conflict`	Konflikt ključa Idempotency-Key
422	`validation-error`	Napačni vnosni podatki (s poljem `errors`)
429	`rate-limited`	Prekoračena omejitev zahtev (Rate-Limit)
500	`internal`	Notranja napaka strežnika

Paginacija

API uporablja paginacijo na podlagi kazalca (cursor-based pagination):

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

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

Rate Limits

Vsak odgovor vsebuje:

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

Interaktivna referenca API

Preizkusite vse končne točke neposredno v brskalniku:

→ Odpri referenco API (Scalar, interaktivno, s funkcijo Try-it-out)

DPP-Contract (faza 4a)

Za delovni tok baterij (battery workflow) qr3.app dodatno dokumentira naslednje poti:

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=...

Nadzorne plošče, knjižnice SDK in ta dokumentacija uporabljajo isto podatkovno pogodbo.