Sürüm politikası

Sürüm bilgisi adresin içinde yer alır: /api/vendor/v1/.... Aşağıda, v2 sürümüne geçmeden hangi değişikliklerin yapılabileceği ve hangilerinin yapılmayacağı tanımlanmıştır.

Uyumluluğu bozmayan değişiklikler

Uygulamanızı aşağıdaki değişikliklere dayanıklı olacak biçimde geliştirin:

• Yanıta yeni alan eklenmesi. Tanımlı olmayan alanları yok sayın.
• İsteğe yeni ve isteğe bağlı alan eklenmesi. Mevcut istekleriniz çalışmayı sürdürür.
• Yeni uç nokta eklenmesi.
• Yeni bildirim türü eklenmesi. Tanımlı olmayan bir X-Hizliyo-Event değeri geldiğinde 2xx döndürün.
• Mevcut bir listeye yeni değer eklenmesi — örneğin yeni bir failureReason. Tanımlı değerleri işleyin, diğerleri için makul bir varsayılan tanımlayın.
• Hata mesajlarının metninin değiştirilmesi. Uygulama mantığınızı errorCode alanı üzerine kurun, mesaj metni üzerine değil.

En sık karşılaşılan entegrasyon hatası

Tanımlı olmayan bir alanla karşılaştığında hata üreten katı JSON çözümleyicileri. Yanıta bir alan eklendiğinde, bu yapıyı kullanan sistemlerde tüm siparişler başarısız olur. Canlıya çıkmadan önce çözümleyicinizi, fazladan gelen alanları yok sayacak biçimde yapılandırın.

Sürüm değişikliği gerektiren değişiklikler

• Bir alanın kaldırılması veya adının değiştirilmesi
• Bir alanın tipinin değiştirilmesi
• İsteğe bağlı bir alanın zorunlu hâle getirilmesi
• Bir uç noktanın kaldırılması
• Bir durumun veya hata kodunun anlamının değiştirilmesi

v2 sürümüne geçiş

• v2 yayımlanır ve v1 ile birlikte belgelenir
• v1 en az altı ay daha hizmet vermeyi sürdürür
• v2 yayımlanırken v1 için kapanış tarihi duyurulur, tarih yaklaştıkça hatırlatma yapılır
• İki sürüm bir arada çalışır; geçişi hazır olduğunuzda gerçekleştirirsiniz

Güvenlik istisnası

Bir güvenlik açığının kapatılması gerektiğinde, değişiklik olağan sürecin dışında yürürlüğe girebilir. Bu durumda değişikliğin kapsamı ve gerekçesi tarafınıza bildirilir. Altı aylık taahhüdün geçerli olmadığı tek durum budur.

Yapılandırma parametreleri

İstek limitleri, zaman aşımı süreleri ve test ortamının davranışı yapılandırma parametreleridir; API sözleşmesinin parçası değildir. Makul bir bildirim süresiyle değiştirilebilir ve sürüm değişikliği sayılmaz. Limitler hesap bazında yapılandırılır, bkz. İstek limitleri.

Duyuru kanalları

• Sürüm notları — her değişiklik, tarihiyle birlikte
• Teknik duyurular, tarafımıza bildirdiğiniz e-posta adresine iletilir

Bildirdiğiniz e-posta adresini güncel tutun ve düzenli olarak takip edilen bir adres olarak tanımlayın.