Önizleme: Public API henüz yayında değil. Rehberler ilk uçlar açılmadan önce paylaşılan taslaklardır ve değişebilir.

Sınırlar ve sürümleme

Taslak.

Rate limit

İstek sınırı firma (tenant) bazında uygulanır. Aynı firmaya bağlı istemciler sınırı birlikte tüketir.

Genel öneri: sınırlandırıldığınızda hemen yeniden denemeyin; bekleme süresini katlayarak artırın.

Sürüm yolun içindedir: /api/v1.
v1 içinde yalnızca eklemeli değişiklikler olur (yeni uç, yeni isteğe bağlı alan, yeni yanıt alanı). İstemciniz bilmediği yanıt alanlarını yok saymalıdır.
Mevcut alanın anlamını, biçimini veya zorunluluğunu bozan her değişiklik kırıcıdır ve yalnızca yeni major sürümde (/api/v2) yapılır.
Webhook olaylarının şeması da sürümlüdür: şema değişirse olayın yeni bir sürümü yayımlanır (bkz. Webhook ve olaylar).
Dosya şablonları (içe/dışa aktarım) sablon_kodu ve sablon_surumu taşır; kırıcı değişiklik yeni şablon sürümüdür.

Yeni major sürüm yayımlandığında önceki major sürüm en az 12 ay desteklenir.
Kullanımdan kaldırma duyuruları değişiklik günlüğünde yer alır.
Kullanımdan kaldırılan sürümün kapatılacağı tarih, duyuruda belirtilir.

Bütün değişiklikler CHANGELOG.md dosyasında tutulur.