API-overzicht

De qr3.app REST-API is bereikbaar via https://qr3.app/v1/.

Versiebeheer

De API is geversioneerd via het URL-pad (/v1/). Breaking changes leiden altijd tot een nieuwe hoofdversie.

Request-indeling

Content-Type: application/json
Authenticatie: Authorization: Bearer qr3_sk_xxx
Idempotentie: POST-requests kunnen idempotent worden gemaakt met Idempotency-Key: <uuid>

Response-indeling

Alle succesvolle responses retourneren JSON:

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

Lijst-responses hebben altijd een meta.pagination-structuur:

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

Foutindeling (RFC 7807)

Alle fouten volgen de standaard 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	Fouttype	Beschrijving
400	`bad-request`	Ongeldige JSON of ontbrekende verplichte velden
401	`authentication`	Ontbrekende of ongeldige API-key
403	`forbidden`	Geen machtiging voor deze bron
404	`not-found`	Bron niet gevonden
409	`conflict`	Idempotency-Key-conflict
422	`validation-error`	Ongeldige invoergegevens (met `errors`-array)
429	`rate-limited`	Rate limit overschreden
500	`internal`	Interne serverfout

Paginering

De API maakt gebruik van cursor-gebaseerde paginering:

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

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

Rate limits

Elk antwoord bevat:

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

Interactieve API-referentie

Test alle eindpunten direct in de browser:

→ API-referentie openen (Scalar, interactief, met Try-it-out)

DPP-Contract (Fase 4a)

Voor de batterij-workflow documenteert qr3.app bovendien deze routes:

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

De dashboardpagina’s, SDKs und deze documentatie gebruiken hetzelfde datacontract.