Skip to main content
API versiyonu URL’de yer alır:
Bir versiyonu kullanan entegrasyon, o versiyon desteklendiği sürece bozulmaz. Kırıcı bir değişiklik gerektiğinde yeni bir versiyon (v2) yayımlanır ve eski versiyon bir süre daha çalışmaya devam eder.

Neler aynı versiyonda değişebilir?

Aşağıdaki değişiklikler geriye uyumludur ve mevcut versiyonda, duyuru yapılmadan yayımlanabilir. Entegrasyonunuzu bunlara dayanıklı yazın:
  • Yeni endpoint eklenmesi
  • İsteğe isteğe bağlı yeni alan eklenmesi
  • Yanıta yeni alan eklenmesi (tanımadığınız alanları yok sayın)
  • Hata mesajlarının metninin değişmesi (mantığınızı HTTP durum koduna dayandırın, mesaj metnine değil)
  • Yanıttaki alanların sırasının değişmesi

Neler yeni versiyon gerektirir?

  • Bir alanın ya da endpoint’in kaldırılması veya adının değişmesi
  • Yeni zorunlu alan eklenmesi
  • Bir alanın tipinin ya da anlamının değişmesi
  • Doğrulama kurallarının daha katı hale gelmesi
  • Varsayılan davranışın değişmesi

Versiyon yaşam döngüsü

Bir versiyon eskimiş olarak işaretlendikten sonra en az 6 ay daha çalışır.

Header’lar

Endpoint’e ulaşan yanıtlar, desteklenen versiyonları api-supported-versions header’ında bildirir. Kullandığınız versiyon eskimiş olarak işaretlendiğinde api-deprecated-versions header’ı da döner. Bu header’ı izleyerek geçiş zamanını otomatik olarak fark edebilirsiniz:

Versiyonlar