Sürümleme ve kullanımdan kaldırma

Sürüm, yolun içindedir: /v1. Bir sürüm içinde API yalnızca büyür:

• yeni uç noktalar, yeni isteğe bağlı girdiler, yanıtlarda yeni alanlar;
• açık uçlu olarak belgelenen alanlarda yeni değerler (olay türleri, eşleşme gerekçeleri, hata kodları).

İstemcilerinizi, bilmedikleri alanları yok sayacak ve açık uçlu alanların bilinmeyen değerlerini işleyebilecek şekilde yazın. Bunun dışındaki her şey (bir alanı kaldırmak ya da yeniden adlandırmak, yeni bir zorunlu girdi, değişen bir anlam) yeni bir sürümdür ve eskisinin yanında sunulur.

Bir kaldırma nasıl duyurulur

Kaldırılacak bir uç nokta, çalışmayı bırakmasından en az 12 ay önce duyurulur. Duyurudan itibaren yanıtları şu başlıkları taşır:

Deprecation: @1793491200
Sunset: Mon, 01 Nov 2027 00:00:00 GMT
Link: <https://birlesa.com/developers/deprecations#companies-list>; rel="deprecation"; type="text/html"

• Deprecation (RFC 9745(yeni sekmede açılır)): ne zaman duyurulduğu, Unix saniyesi olarak.
• Sunset (RFC 8594(yeni sekmede açılır)): ne zaman çalışmayı bırakacağı.
• Link: yerine neyin geçtiğini ve geçişin nasıl yapılacağını açıklayan duyuru.

OpenAPI belgesi işlemi deprecated olarak işaretler. Anahtarları onu hâlâ çağıran kuruluşlara ayrıca e-postayla da haber verilir. Bu başlıkları istemcinizde günlüğe kaydedin: alacağınız en erken uyarı onlardır.

Webhook yükleri de aynı kurala uyar. Biçimleri (id, type, created_at, data) /v1 içinde değişmez; yeni olay türleri ortaya çıkabilir ve bir webhook yalnızca istediği türleri alır.