Hoppa till innehåll

API-versionshantering & LTS-policy

API-versionshantering & LTS-policy

Versionshanteringsschema

qr3.app använder URL-baserad versionshantering: /v1/, /v2/, osv.

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

Den aktuella stabila versionen är v1 LTS .


Versionslivscykel

Neu → Stable (LTS) → Maintenance → End-of-Life
Beta-Phase Aktiv Nur Fixes Eingestellt
(0–3 Monate) (12+ Monate) (6 Monate) (danach)
VersionStatusSupport tillAnteckningar
v1✅ Stable (LTS)Minst mars 2027Aktuell produktionsversion
v2📋 PlaneradRoadmap: Fas 5+

Breaking Changes — Definition

En Breaking Change är varje ändring som gör att befintliga klienter slutar fungera utan anpassning:

  • Borttagning eller namnbyte av Request-/Response-fält
  • Ändring av HTTP-statuskoder för befintliga scenarier
  • Borttagning av Endpoints
  • Ändring av autentiseringsmetod
  • Inkompatibla ändringar av felformatet

Inga Breaking Changes (kompatibla utökningar):

  • Tillägg av valfria Request-fält
  • Tillägg av nya Response-fält
  • Nya Endpoints
  • Nya valfria Query-parametrar
  • Nya felkoder (RFC 7807 förblir kompatibel)

Kommunikation av Breaking Changes

Breaking Changes genomförs aldrig utan förvarning:

  1. Avisering: Minst 90 dagar före en Breaking Change
  2. Kanal: E-post till alla API-användare + dashboard-banner + CHANGELOG.md
  3. Migrationshjälp: Migrationsguide och kodexempel
  4. Deprecation-headers: API:et returnerar HTTP-headerna Deprecation + Sunset
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)

För den aktuella LTS-versionen v1 gäller:

GarantiTidsperiod
Inga Breaking ChangesMinst 12 månader från Stable-status
Security PatchesUnder hela LTS-löptiden
Bug FixesUnder hela LTS-löptiden
Maintenance Mode6 månader efter LTS-slut
Fullständig supportMinst till mars 2027

Identifiera version

Varje API-svar innehåller metadata om den aktuella versionen:

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

Ändpunkten GET /v1/health returnerar dessutom:

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

Migration mellan versioner

När en ny huvudversion släpps förblir den gamla versionen aktiv parallellt i minst 6 månader.

Vi tillhandahåller:

  • Fullständig diff av alla ändrade Endpoints
  • Automatiskt migrationsverktyg (där det är möjligt)
  • Personlig migrationssupport för Business-/Agency-kunder

Deprecation-policy för enskilda Endpoints

Enskilda Endpoints kan också markeras som deprecated inom 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

Alla API-ändringar dokumenteras i CHANGELOG.md i arkivet.

DatumVersionTypBeskrivning
Mars 2026v1.0.0InitialFörsta stabila releasen: QR-koder, Redirect, Auth, Billing
Mars 2026v1.1.0FeatureBatch-API, A/B-Destinations, Expiry, PDF-export
Mars 2026v1.2.0FeatureOrganizations, Workspaces, Audit-Logs, Comments, GDPR-Endpoints

Frågor?

Vid frågor om versionshanteringspolicyn: [email protected]