Skip to main content
Flextell REST API’si tek bir sürüm sunar: v1. Bu sayfa sürüm önekinin ne anlama geldiğini, uyumsuz değişikliklerin nasıl yayımlandığını ve entegrasyonunuzu bozabilecek değişiklikleri nasıl takip edeceğinizi anlatır.

​
Sürüm öneki

Tüm REST endpoint’leri /api/v1 altındadır.
v2 yoktur. Sürüm öneki, API’nin kalıcı olarak dondurulduğu anlamına gelmez; uyumsuz değişiklikler de v1 içinde yayımlanır (sonraki bölüme bakın).
Sürüm öneki geriye dönük uyumluluk güvencesi vermez. Entegrasyonunuzu v1 değişmeyecek varsayımıyla yazmayın; değişiklikleri düzenli takip edin.

​
Sürüm öneki taşımayan adresler

Aşağıdaki adresler /api/v1 altında değildir ve ayrı bir sürüm numarası taşımaz.

​
OpenAPI belgesindeki sürüm numarası

OpenAPI belgesinin info.version alanı 0.0.1 değerini taşır ve sürümlerle birlikte artmaz. Değişiklikleri bu alana bakarak izlemeyin; Değişiklikleri takip etme bölümündeki sayfaları kullanın.

​
Uyumlu ve uyumsuz değişiklikler

Flextell, sürüm numarasını artırmadan hem eklemeler hem de uyumsuz değişiklikler yayımlar. Hangi durumda ne beklemeniz gerektiği aşağıdaki tabloda özetlenmiştir.
Yanıtlarda tanımadığınız alanları yok sayın ve hata işlemede error_code değerine göre dallanın. Böylece eklemeler entegrasyonunuzu bozmaz. Hata zarfı için Hatalar sayfasına bakın.

​
Yeniden adlandırılan parametreler

Daha önce yayımlanmış bir parametre yeniden adlandırıldığında eski ad takma ad olarak korunmaz. Yeni ad geçerli olur; eski adı gönderen istek artık aynı sonucu vermez. Tarih filtrelerinde bunun örneği yaşandı: <alan>_from ve <alan>_to biçimi tek geçerli ad oldu, date_from, date_to, from, to ve created_from gibi eski adlar kaldırıldı. Güncel kurallar için Filtreleme ve sıralama sayfasına bakın.

​
Kaldırılan özellikler

Kaldırılan özellikler önce kullanımdan kaldırılmış olarak işaretlenmez; doğrudan kalkar. Silme yaşam döngüsündeki değişiklik buna örnektir: kayıt başına geri yükleme ve kalıcı silme endpoint’leri ile trashed filtreleri kaldırıldı, yerine Geri Dönüşüm Kutusu geldi. Bkz. Silme yaşam döngüsü.

​
Kullanımdan kaldırma

Flextell’de resmî bir kullanımdan kaldırma süresi yoktur. API yanıtları Deprecation veya Sunset başlığı göndermez; bu başlıklara bakarak uyarı almazsınız. Tek istisna, yayımlanmış mobil uygulama sürümlerinin kullandığı alanlardır. Bu alanlar silinmez, kullanımdan kaldırılmış olarak belgelenir ve çalışmaya devam eder. Yeni entegrasyonlarda bunların yerine önerilen alanı kullanın.
Bu tablo kullanımdan kaldırılan her şeyi kapsamayı amaçlamaz; yalnızca korunan ve belgelenen alanları listeler. Bir değişikliğin kaldırma mı, yeniden adlandırma mı olduğunu API değişiklikleri sayfasından kontrol edin.

​
Değişiklikleri takip etme

Entegrasyonunuzu bozabilecek değişiklikler için iki sayfayı izleyin.

API değişiklikleri

Yeni izin zorunlulukları, yeniden adlandırmalar, değişen yanıtlar ve kaldırılan endpoint’ler. Tarih sırasıyla listelenir.

Platform sürüm notları

Yeni ve geriye uyumlu eklemeler.
Önerilen çalışma biçimi:
1

Yayımlanan değişiklikleri düzenli okuyun

API değişiklikleri sayfasını, entegrasyonunuzu güncellemeden önce ve düzenli aralıklarla okuyun. Kayıtlar yeniden eskiye sıralıdır.
2

Hata kodlarına göre dallanın

Hata işlemenizi HTTP metnine değil error_code değerine bağlayın. Güncel liste için Hata kodları sayfasına bakın.
3

İzinleri ve başlıkları doğrulayın

Bir değişiklik yeni bir izin ya da başlık istiyorsa, entegrasyonu kullanan kullanıcının rolünü ve istek başlıklarını kontrol edin. Başlıklar için İstek başlıkları sayfasına bakın.