Przegląd API

REST API qr3.app jest dostępne pod adresem https://qr3.app/v1/.

Wersjonowanie

API jest wersjonowane poprzez ścieżkę URL (/v1/). Zmiany wprowadzające niekompatybilność wsteczną (breaking changes) zawsze prowadzą do nowej wersji głównej.

Format żądania

Content-Type: application/json
Uwierzytelnianie: Authorization: Bearer qr3_sk_xxx
Idempotentność: Żądania POST mogą być idempotentne dzięki nagłówkowi Idempotency-Key: <uuid>

Format odpowiedzi

Wszystkie pomyślne odpowiedzi zwracają JSON:

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

Odpowiedzi listujące zawsze zawierają strukturę meta.pagination:

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

Format błędów (RFC 7807)

Wszystkie błędy są zgodne ze 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 błędu	Opis
400	`bad-request`	Nieprawidłowy JSON lub brak wymaganych pól
401	`authentication`	Brakujący lub nieprawidłowy klucz API
403	`forbidden`	Brak uprawnień do tego zasobu
404	`not-found`	Zasób nie został znaleziony
409	`conflict`	Konflikt klucza Idempotency-Key
422	`validation-error`	Błędne dane wejściowe (z tablicą `errors`)
429	`rate-limited`	Przekroczono limit żądań (rate limit)
500	`internal`	Wewnętrzny błąd serwera

Stronicowanie

API korzysta ze stronicowania opartego na kursorze (cursor-based pagination):

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

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

Limity żądań (Rate Limits)

Każda odpowiedź zawiera:

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

Interaktywna referencja API

Przetestuj wszystkie punkty końcowe bezpośrednio w przeglądarce:

→ Otwórz referencję API (Scalar, interaktywna, z funkcją Try-it-out)

DPP-Contract (Faza 4a)

Dla przepływu pracy baterii (battery workflow) qr3.app dodatkowo dokumentuje następujące ścieżki:

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

Strony panelu (dashboard), SDKs oraz ta dokumentacja korzystają z tego samego kontraktu danych.