Developers / Versiyonlama

Versiyonlama

BYNovax External Commerce API major sürümü URL içerisinde açıkça taşır. Mevcut production sürümü v1'dir.

Mevcut endpoint contract'larının kökü /api/external/v1 yoludur.

URL tabanlı versiyonlama

External API major sürümü Base URL'nin bir parçasıdır. Böylece hangi API contract'ına istek gönderdiğiniz URL üzerinden açıkça görülebilir.

Mevcut production API sürümü v1 olduğundan bütün endpointler /api/external/v1 altında bulunur.

https://bynovax.com/api/external/v1

Neden URL içerisinde sürüm var?

Gelecekte geriye uyumsuz büyük bir contract değişikliği gerektiğinde mevcut v1 entegrasyonlarının sessizce bozulmaması amaçlanır.

Yeni bir major API sürümü gerektiğinde entegratörün geçişi kontrollü şekilde yapabilmesi için farklı version path kullanılabilir.

v1 içerisinde güvenebileceğiniz temel contract

  • Endpoint HTTP method ve path yapıları.
  • Credential tabanlı tenant authority.
  • Scope tabanlı authorization.
  • JSON request ve response formatı.
  • Standart success ve error envelope.
  • Idempotency-Key kullanılan write davranışı.

Response parser nasıl yazılmalı?

Response JSON alanlarının sırasına güvenmeyin. Yalnızca ihtiyacınız olan alanları okuyun.

Geriye uyumlu yeni response alanları eklenebileceğinden tanımadığınız alanların varlığını hata olarak değerlendirmeyin.