Leaganú API & Polasaí LTS

Leaganú API & Polasaí LTS

Scéim Leaganaithe

Úsáideann qr3.app leaganú bunaithe ar URL: /v1/, /v2/, srl.

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

Is é v1 an leagan cobhsaí reatha LTS .

---

Saolré an Leagan

Neu         → Stable (LTS) → Maintenance → End-of-Life
 Beta-Phase    Aktiv            Nur Fixes      Eingestellt
 (0–3 Monate)  (12+ Monate)     (6 Monate)     (danach)

Leagan	Stádas	Tacaíocht go dtí	Nótaí
v1	✅ Stable (LTS)	Ar a laghad Márta 2027	Leagan táirgthe reatha
v2	📋 Beartaithe	—	Treochlár: Céim 5+

---

Athruithe Briseacha — Sainmhíniú

Is éard is Athrú Briseach (Breaking Change) ann ná aon athrú a bhriseann cliaint reatha gan oiriúnú:

• Réimsí Request/Response a bhaint nó a athainmniú
• Cóid stádais HTTP a athrú do chásanna reatha
• Críochphointí (Endpoints) a bhaint
• An modh fíordheimhnithe a athrú
• Athruithe neamh-chomhoiriúnacha ar fhormáid na n-earráidí

Ní athruithe briseacha iad seo (síneadh comhoiriúnach):

• Réimsí roghnacha Request a chur leis
• Réimsí nua Response a chur leis
• Críochphointí nua
• Paraiméadair cheiste (Query Parameters) roghnacha nua
• Cóid earráide nua (fanann RFC 7807 comhoiriúnach)

---

Cumarsáid faoi Athruithe Briseacha

Ní dhéantar Athruithe Briseacha choíche gan fógra:

1. Fógra: Ar a laghad 90 lá roimh an Athrú Briseach
2. Cainéal: Ríomhphost chuig gach úsáidir API + meirge deais (Dashboard) + CHANGELOG.md
3. Cabhair Imirce: Treoir imirce agus samplaí cóid
4. Ceanntásca Dímheasa (Deprecation Headers): Soláthraíonn an API ceanntásca HTTP 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"

---

Ráthaíochtaí LTS (v1)

I gcás an leagain LTS reatha v1, tá feidhm ag an méid seo a leanas:

Ráthaíocht	Tréimhse
Gan aon Athruithe Briseacha	Ar a laghad 12 mhí ó stádas Cobhsaí (Stable)
Paistí Slándála	Ar feadh ré iomlán an LTS
Paistí Fabhtanna (Bug Fixes)	Ar feadh ré iomlán an LTS
Mód Cothabhála	6 mhí tar éis dheireadh an LTS
Tacaíocht Iomlán	Ar a laghad go dtí Márta 2027

Leaganú sa SDK

Leanann an TypeScript SDK (@qr3/sdk) agus an CLI (@qr3/cli) SemVer freisin. Athruithe Briseacha sa SDK léiríonn i gcónaí Athruithe Briseacha san API.

---

Leagan a Aithint

Tá meiteashonraí faoin leagan reatha i ngach freagra API (Response):

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

Soláthraíonn an críochphointe GET /v1/health an méid seo a leanas freisin:

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

---

Imirce idir Leaganacha

Nuair a thagann mórleagan nua amach, fanann an seangleagan gníomhach i gcomhthreo leis ar feadh ar a laghad 6 mhí.

Soláthraímid:

• Diff iomlán de gach críochphointe athraithe
• Uirlis imirce uathoibríoch (más féidir)
• Tacaíocht imirce phearsanta do chustaiméirí Business/Agency

---

Polasaí Dímheasa do Chríochphointí Aonair

Is féidir críochphointí aonair a mharcáil mar chinn dhímheasta (deprecated) laistigh de leagan freisin:

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"

Caution

Ná déan neamhaird de cheanntásca Deprecation. Bainfear críochphointí tar éis an dáta Sunset, fiú mura raibh siad ina n-Athrú Briseach fós.

---

Loga Athruithe (Changelog)

Déantar gach athrú API a dhoiciméadú i CHANGELOG.md sa stór.

Dáta	Leagan	Cineál	Cur Síos
Márta 2026	v1.0.0	Tús	Céad scaoileadh cobhsaí: QR-Codes, Redirect, Auth, Billing
Márta 2026	v1.1.0	Gné	Batch-API, A/B-Destinations, Expiry, PDF-Export
Márta 2026	v1.2.0	Gné	Organizations, Workspaces, Audit-Logs, Comments, DSGVO-Endpoints

---

Ceisteanna?

Má tá ceisteanna agat faoin bpolasaí leaganaithe: [email protected]