v1’dir ve tüm uçlar https://<env>.flextell.ai/api/v1/... altında yaşar.
Sürüm stratejisi
| Sürüm | Durum | Yol | Notlar |
|---|---|---|---|
v1 | Aktif | /api/v1/* | Tüm üretim trafiği |
v2 | Yok | — | İleride eklenirse duyuru yapılır |
v2) eklendiğinde:
v1en az 12 ay boyunca paralel çalışmaya devam eder.- Yeni üretilen uygulamalar
v2’ye yönlendirilir;v1token’ları otomatik olarakv2’ye yükseltilmez — uygulamanızın kod tarafında taşıma yapmanız gerekir. v1’in kaldırılma tarihi en az 6 ay önce Changelog üzerinden duyurulur.
Neyi kırıcı (breaking) saymıyoruz?
Aşağıdaki değişiklikler geriye uyumlu kabul edilir vev1 içinde minor versiyon çıkarmadan yayınlanır:
- Bir JSON yanıtına yeni bir alan eklemek.
- Yeni bir opsiyonel istek parametresi eklemek (varsayılanı mevcut davranışla uyumlu).
- Yeni bir endpoint eklemek.
- Yeni bir event payload alanı eklemek.
- Yeni bir scope eklemek (mevcut scope’ların yetkisi aynı kalır).
- Daha fazla HTTP status code kombinasyonu eklemek (zaten belgelenmiş olanları kaldırmadan).
- Hata mesaj metinlerini düzeltmek (hata kodu aynı kaldığı sürece).
İstemcilerinizde bilinmeyen JSON alanlarını göz ardı eden bir parsing yaklaşımı kullanın. Aksi hâlde bu geriye uyumlu eklemeler bile entegrasyonunuzu bozabilir.
Neyi kırıcı sayıyoruz?
Şunlar kırıcı değişiklik kabul edilir ve yalnızca yeni bir ana sürümde (ör.v2) yayınlanır:
- Bir uç’un URL’ini değiştirmek.
- Bir yanıt alanını kaldırmak veya tipini değiştirmek (string → object gibi).
- Zorunlu olmayan bir parametreyi zorunlu hale getirmek.
- Bir enum değerini kaldırmak.
- Bir scope’un yetkisini daraltmak (genişletmek kırıcı değildir).
- HTTP status kodlarının varsayılan kombinasyonunu değiştirmek (örn. 200 yerine 204’e geçmek).
İstisnalar ve önceden bildirimsiz değişiklikler
Güvenlik veya uyumluluk gereğince acil yapılması gereken değişiklikleri önceden bildirmeden uygulayabiliriz. Örneğin:- Kritik bir güvenlik açığı için bir alanın redaction’ı.
- KVKK/HIPAA uyumu için bir yanıtın maskelenmesi veya kaldırılması.
Dokümantasyon tutarlılığı
Bu dokümantasyon, canlı API kodundan otomatik üretilen OpenAPI şeması ile senkronize tutulur. Yazılı rehberler (bu sayfa gibi) ve OpenAPI referansı arasında bir tutarsızlık görürseniz:- OpenAPI şeması “doğru” kabul edilir (kod ile birebir eşleştirilir).
- Yazılı rehber açıklayıcı bir özet sunar; ciddi fark varsa destek ile iletişime geçin.