API sözleşmesi v1
Sürüm ve değişiklikler
Bu sayfa API sözleşmesinden üretilir: aşağıdaki kural sözleşmenin “Sürümleme” bölümünden, kapsam sayıları yayınlanan sayfa kümesinden gelir.
v1 yüzeyinin kapsamı
| Alan | Değer |
|---|---|
| Yayındaki sürüm | v1 |
| Taban yol | /api/v1 |
| İstek ucu | 65 |
| Doküman sayfası | 68 |
| Giden webhook olayı | shipment.updated |
Sürümleme
URI sürümlemesi: /api/v1. v1 içinde yalnız geriye uyumlu genişleme yapılır: yeni uç, yeni isteğe bağlı alan, yanıt gövdesine yeni alan, status enum'una yeni değer eklenebilir; mevcut alan kaldırılmaz, tipi/anlamı değiştirilmez. Tüketici bilinmeyen yanıt alanlarını ve bilinmeyen status değerlerini toleransla işlemelidir (Hyrum farkındalığı). Kırıcı değişiklik yeni kök altında (/api/v2) yayınlanır; v1 duyurulu bir geçiş süresi boyunca yaşar (expand-migrate-contract).