Değişiklik günlüğü ve kullanımdan kaldırma politikası

Neye güvenebileceğinizi önceden bilmeden entegrasyon inşa edilmez. Politika sözleşmenin parçasıdır.

Kullanımdan kaldırma politikası

  • 12 ay bildirim. Kırıcı bir değişiklik, ilanından en az on iki ay sonra yürürlüğe girer. Kırıcı sayılanlar: bir ucun ya da alanın kaldırılması, bir alanın tipinin ya da anlamının değişmesi, yeni bir zorunlu parametre, mevcut bir isteğin artık hata döndürmesi.
  • Deprecation ve Sunset başlıkları. Kullanımdan kaldırılan bir yüzey, o günden itibaren her yanıtında Deprecation: true ve Sunset (RFC 8594 biçiminde kapanış tarihi, örn. Mon, 04 Jan 2027 00:00:00 GMT) başlıklarını taşır. Deprecation bir TARİH DEĞİLDİR, yalnız bayraktır. Bugün bu ikili emekli yetki KODLARI için basılıyor ve /v1 yanıtlarında da görülebilir; uç emekliliğinde de aynı biçim kullanılacaktır. Kapanışı öğrenmek için bu sayfayı izlemek zorunda değilsiniz — istemciniz kendi loglarından görür.
  • Sessiz davranış değişikliği asla. Yanıtın anlamını değiştiren hiçbir şey duyurusuz yapılmaz. Bu, kırıcı bir değişiklikten sonra verilen bir söz değildir; yayımlanmış olmasının sebebi de budur.
  • Bunlar kırıcı DEĞİLDİR ve istemciniz bunlara dayanıklı olmalıdır: yanıta yeni bir alan eklenmesi, yeni bir uç ya da yeni bir opsiyonel parametre, mevcut bir sözlüğe (örn. status_detail) yeni bir değerin girmesi, hata mesajı metninin değişmesi. Bilinmeyen alanları yok sayın, bilinmeyen kodlara “diğer” deyin.
  • Yol versiyonlanır. Uyumsuz bir sözleşme /v1’i değiştirmez, /v2 olarak doğar.

Günlük

1.0.0 — İlk yayın (2026-09)

  • `/v1` okuma yüzeyi: me, contacts (+ ledger), products (+ inventory-levels), stock-movements, warehouses, item-categories, tags, invoices, inbox-invoices, receipts, despatches, e-invoice-inboxes, accounts (+ transactions), exchange-rates, units.
  • `/v1` yazma yüzeyi: cari, stok kartı, kategori ve etiket için oluşturma/güncelleme/silme; stok hareketi yalnız oluşturma; fatura oluşturma/güncelleme/silme, gönderim (202, asenkron) ve iptal.
  • Anahtar başına kapsam seçimi: anahtar yalnız kendisine verilen yetkileri taşır.
  • Anahtar başına dakikada 60 istek, `X-RateLimit-*` ve 429’da `Retry-After` başlıklarıyla.
  • Sözleşmenin kendisi uçtan yayımlanır: `GET /v1/openapi.yaml`.

Bugüne kadar kullanımdan kaldırılmış bir uç ya da alan yoktur. Olduğunda burada, kaldırma tarihiyle birlikte durur ve kayıt silinmez.

Bilinen kısıt — bugün açılamayan uçlar

Aşağıdaki kaynakların istediği kapsam kodu, API anahtarının taşıyabileceği kod kümesinde HENÜZ yok; bu uçlar bugün hangi anahtarla olursa olsun 403 forbidden döner: tags (okuma ve yazma), receipts, despatches, e-invoice-inboxes, accounts (+ transactions), exchange-rates, units, DELETE /v1/invoices/{id} ve POST /v1/invoices/{id}/cancel.

Sözleşmede duruyorlar ve yayımlanmış davranışları değişmeyecek — eksik olan yalnız anahtara verilebilen kapsam listesidir. Açıldığında bu bölüm kalkar ve günlüğe satır olarak düşer; kapsam kümesinin genişlemesi kırıcı bir değişiklik DEĞİLDİR.