Kaynaklar
Sürüm politikası
Out API'de değişikliklerin nasıl yapıldığını, nasıl duyurulduğunu ve entegrasyonunuzu değişikliklere karşı nasıl dayanıklı tutacağınızı anlatır.
Tek sürüm
API adresinde sürüm numarası yoktur. Out API'nin tek bir sürümü vardır ve geriye uyumlu biçimde geliştirilir. Tüm değişiklikler değişiklik günlüğünde yayımlanır.
Geriye uyumlu değişiklikler
Aşağıdaki değişiklikler mevcut entegrasyonları bozmaz; önceden duyurulmadan yapılabilir ve değişiklik günlüğüne yazılır:
- Yeni servis eklenmesi.
- Yanıtlara yeni alan eklenmesi.
- İsteklere isteğe bağlı yeni alan eklenmesi.
- Kodsuz dönen bir hataya hata kodu eklenmesi veya hata mesajlarının netleştirilmesi.
- Hata ve güvenlik düzeltmeleri.
Uyumsuz değişiklikler
Bir servisin veya alanın kaldırılması, bir alanın anlamının ya da biçiminin değiştirilmesi ve isteğe zorunlu alan eklenmesi uyumsuz değişikliktir. Bu değişiklikler için:
- Değişiklik, yürürlüğe girmeden en az 90 gün önce değişiklik günlüğünde duyurulur.
- Etkilenen servis, dokümanda Kaldırılacak olarak işaretlenir; sayfasında tarih ve yerine kullanılacak servis yazar.
- Tarih geldiğinde kaldırılan servis HTTP
410döndürür.
Bir güvenlik açığını kapatmak için gereken değişiklikler bu süreyi beklemeden yapılabilir. Bu durumda değişiklik, yayınlandığı gün değişiklik günlüğüne yazılır.
Entegrasyonunuzu dayanıklı tutun
- Yanıtta tanımadığınız alanları yok sayın; yeni alanlar duyurusuz eklenebilir.
- Değeri boş olan alanların yanıtta hiç yer almayabileceğini hesaba katın.
- Kararı
ResultveErrorCodeile verin;ErrorMessagemetni değişebilir. - Tanımadığınız bir
ErrorCode'u genel hata olarak ele alın ve kaydedin. 00001veya00006aldığınızdaDoile yeniLogin ApiCodealıp isteği bir kez tekrarlayın.- Değişiklik günlüğünü düzenli olarak takip edin.