Skip to content
qr3.app Docs

API versiju pārvaldība un LTS politika

API versiju pārvaldība un LTS politika

Versiju izveides shēma

qr3.app izmanto uz URL balstītu versiju izveidi: /v1/, /v2/ utt.

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

Pašreizējā stabilā versija ir v1 LTS .

Versijas dzīves cikls

Neu         → Stable (LTS) → Maintenance → End-of-Life
 Beta-Phase    Aktiv            Nur Fixes      Eingestellt
 (0–3 Monate)  (12+ Monate)     (6 Monate)     (danach)
VersijaStatussAtbalsts līdzPiezīmes
v1✅ Stable (LTS)Vismaz 2027. gada martsPašreizējā produkcijas versija
v2📋 Plānots—Ceļvedis: 5. fāze+

Neatgriezeniskas izmaiņas (Breaking Changes) — definīcija

Neatgriezeniska izmaiņa (Breaking Change) ir jebkura izmaiņa, kas sabojā esošo klientu darbību bez pielāgošanas:

  • Request/Response lauku noņemšana vai pārdēvēšana
  • HTTP statusa kodu maiņa esošajiem scenārijiem
  • Galapunktu (Endpoints) noņemšana
  • Autentifikācijas metodes maiņa
  • Nesaderīgas izmaiņas kļūdu formātā

Nav neatgriezeniskas izmaiņas (saderīgi paplašinājumi):

  • Izvēles Request lauku pievienošana
  • Jaunu Response lauku pievienošana
  • Jauni galapunkti (Endpoints)
  • Jauni izvēles Query parametri
  • Jauni kļūdu kodi (RFC 7807 saglabājas saderīgs)

Paziņošana par neatgriezeniskām izmaiņām

Neatgriezeniskas izmaiņas nekad netiek veiktas bez iepriekšēja brīdinājuma:

  1. Paziņojums: Vismaz 90 dienas pirms neatgriezeniskās izmaiņas
  2. Kanāls: E-pasts visiem API lietotājiem + vadības paneļa (Dashboard) baneris + CHANGELOG.md
  3. Palīdzība migrācijā: Migrācijas rokasgrāmata un kodu piemēri
  4. Deprecation galvenes: API nodrošina Deprecation + Sunset HTTP galvenes
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 garantijas (v1)

Uz pašreizējo LTS versiju v1 attiecas:

GarantijaPeriods
Nav neatgriezenisku izmaiņuVismaz 12 mēneši kopš Stable statusa
Drošības ielāpi (Security Patches)Visā LTS darbības laikā
Kļūdu labojumi (Bug Fixes)Visā LTS darbības laikā
Uzturēšanas režīms (Maintenance Mode)6 mēneši pēc LTS beigām
Pilns atbalstsVismaz līdz 2027. gada martam

Versijas noteikšana

Katrā API atbildē (Response) ir ietverti metadati par pašreizējo versiju:

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

Galapunkts GET /v1/health papildus nodrošina:

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

Migrācija starp versijām

Kad tiek izlaista jauna galvenā versija, vecā versija paliek aktīva paralēli vismaz 6 mēnešus.

Mēs nodrošinām:

  • Pilnīgu visu mainīto galapunktu (Endpoints) salīdzinājumu (Diff)
  • Automātisku migrācijas rīku (kur iespējams)
  • Personīgu migrācijas atbalstu Business/Agency klientiem

Deprecation politika atsevišķiem galapunktiem

Atsevišķi galapunkti var tikt atzīmēti kā novecojuši (deprecated) arī vienas versijas ietvaros:

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"

Izmaiņu žurnāls (Changelog)

Visas API izmaiņas tiek dokumentētas repozitorija failā CHANGELOG.md.

DatumsVersijaVeidsApraksts
2026. gada martsv1.0.0SākotnējāPirmais stabilais laidiens: QR kodi, pāradresācija (Redirect), Auth, norēķini (Billing)
2026. gada martsv1.1.0FunkcijaBatch API, A/B galamērķi (A/B-Destinations), derīguma termiņš (Expiry), PDF eksports
2026. gada martsv1.2.0FunkcijaOrganizācijas (Organizations), darba vietas (Workspaces), audita žurnāli (Audit-Logs), komentāri (Comments), DSGVO galapunkti

Jautājumi?

Ja jums ir jautājumi par versiju izveides politiku: [email protected]