Gå til indhold

API-versionering & LTS-politik

API-versionering & LTS-politik

Versioneringsskema

qr3.app anvender URL-baseret versionering: /v1/, /v2/, osv.

https://qr3.app/v1/codes
^^^
Versionspräfix

Den aktuelle stabile version er v1 LTS .


Versionslivscyklus

Neu → Stable (LTS) → Maintenance → End-of-Life
Beta-Phase Aktiv Nur Fixes Eingestellt
(0–3 Monate) (12+ Monate) (6 Monate) (danach)
VersionStatusSupport indtilNoter
v1✅ Stable (LTS)Min. marts 2027Aktuel produktionsversion
v2📋 PlanlagtRoadmap: Fase 5+

Breaking Changes — Definition

En breaking change er enhver ændring, der ødelægger eksisterende klienter uden tilpasning:

  • Fjernelse eller omdøbning af request-/response-felter
  • Ændring af HTTP-statuskoder for eksisterende scenarier
  • Fjernelse af endpoints
  • Ændring af godkendelsesmetoden
  • Inkompatible ændringer af fejlformatet

Ikke breaking changes (kompatible udvidelser):

  • Tilføjelse af valgfrie request-felter
  • Tilføjelse af nye response-felter
  • Nye endpoints
  • Nye valgfrie query-parametre
  • Nye fejlkoder (RFC 7807 forbliver kompatibel)

Kommunikation af breaking changes

Breaking changes udføres aldrig uden varsel:

  1. Varsel: Mindst 90 dage før en breaking change
  2. Kanal: E-mail til alle API-brugere + dashboard-banner + CHANGELOG.md
  3. Migrationshjælp: Migrationsvejledning og kodeeksempler
  4. Deprecation-headere: API’et leverer Deprecation + Sunset HTTP-headere
HTTP/1.1 200 OK
Deprecation: true
Sunset: Sat, 01 Mar 2027 00:00:00 GMT
Link: <https://docs.qr3.app/de/api/versioning>; rel="deprecation"

LTS-garantier (v1)

For den aktuelle LTS-version v1 gælder:

GarantiPeriode
Ingen breaking changesMin. 12 måneder fra Stable-status
SikkerhedspatchesI hele LTS-perioden
FejlrettelserI hele LTS-perioden
Vedligeholdelsestilstand6 måneder efter LTS-ophør
Fuld supportMin. indtil marts 2027

Identificer version

Hvert API-svar indeholder metadata om den aktuelle version:

{
"data": { ... },
"meta": {
"request_id": "req_abc123",
"api_version": "1.0.0"
}
}

Endpointet GET /v1/health leverer desuden:

{
"version": "1.0.0",
"environment": "production",
"status": "ok"
}

Migration mellem versioner

Når en ny hovedversion udgives, forbliver den gamle version aktiv i mindst 6 måneder sideløbende.

Vi stiller følgende til rådighed:

  • Komplet diff over alle ændrede endpoints
  • Automatisk migrationsværktøj (hvor det er muligt)
  • Personlig migrationssupport til Business-/Agency-kunder

Deprecation-politik for enkelte endpoints

Enkelte endpoints kan også markeres som deprecated inden for en version:

GET /v1/codes HTTP/1.1
HTTP/1.1 200 OK
Deprecation: true
Sunset: Thu, 01 Jan 2026 00:00:00 GMT
Link: <https://docs.qr3.app/de/api/codes>; rel="deprecation"

Changelog

Alle API-ændringer dokumenteres i CHANGELOG.md i repositoryet.

DatoVersionTypeBeskrivelse
Marts 2026v1.0.0InitialFørste stabile udgivelse: QR-koder, Redirect, Auth, Billing
Marts 2026v1.1.0FeatureBatch-API, A/B-destinationer, Expiry, PDF-eksport
Marts 2026v1.2.0FeatureOrganizations, Workspaces, Audit-logs, Comments, GDPR-endpoints

Spørgsmål?

Ved spørgsmål til versioneringspolitikken: [email protected]