Politikalar

API politikaları

Data API'nin nasıl sürümlendiği, kullanımdan kaldırmaların nasıl duyurulduğu ve ne kadar sürdüğü, ve bir güvenlik sorununun nasıl bildirileceği.

Sürümleme

API, yol üzerinden sürümlenir: her uç nokta /api/v1 altında yer alır. Sözleşmenin info.version değeri (şu anda 1.1.0) değişiklik günlüğünü izler: bir şey eklendiğinde minör numara, bir şey düzeltildiğinde yama numarası artar ve kırıcı bir değişiklik yalnızca yeni bir yol sürümüyle (/api/v2) yayımlanır.

Sekiz resmi SDK, API'yi takip eder: yeni bir uç nokta minör bir SDK sürümü, kaldırılan veya yeniden adlandırılan bir uç nokta ise majör bir sürüm demektir.

Neler kırıcı sayılır

Bunlar bir yol sürümü içinde asla yapılmaz:

• Bir uç noktanın, sorgu parametresinin veya yanıt alanının kaldırılması ya da yeniden adlandırılması.
• Bir alanın türünün ya da fiyatların, kurların ve arzların ondalık dize olması kuralının değiştirilmesi.
• { data, meta } zarfının, hata zarfının veya mevcut bir hata kodunun anlamının değiştirilmesi.
• Bir planın halihazırda sahip olduğu bir hız sınırının veya kotanın düşürülmesi.

Bunlar her an olabilir ve değişiklik günlüğünde duyurulur:

• Yeni uç noktalar, sorgu parametreleri ve yanıt alanları.
• Yeni durumlar için yeni hata kodları - her zaman error.code üzerinden eşleştirin, asla mesaj üzerinden değil.
• Referansın büyüyebileceğini belirttiği listelere yeni değerler; örneğin olay adları ve gösterge adları.
• Daha yüksek limitler ve kotalar.

Kullanımdan kaldırma

Bir uç nokta, parametre veya alan kaldırılmak üzere planlandığında bu, değişiklik günlüğünde ve her anahtar sahibine e-postayla duyurulur; o günden itibaren uç nokta, kaldırma tarihini belirten Deprecation ve Sunset başlıklarıyla (RFC 9745, RFC 8594) yanıt verir. OpenAPI sözleşmesi bunu deprecated: true ile işaretler.

Kaldırma, duyurudan en az altı ay sonra gerçekleşir. Yeni bir yol sürümü, eskisi aynı şekilde sonlandırılmadan önce en az altı ay boyunca öncekiyle birlikte çalışır.

Limitler ve adil kullanım

Dakika başına ani istek limitleri ve aylık kotalar planınızın bir parçasıdır; her yanıtta X-RateLimit-* ve X-Quota-* başlıklarında bildirilir ve referansta belgelenir. Bir limiti yükseltmek asla kırıcı değildir; bir plan içinde düşürmek ise kırıcıdır ve kullanımdan kaldırma takvimini izler.

Sorumlu ifşa

bitculator.com, Data API, MCP sunucusu veya SDK'larda bir güvenlik açığı bulduğunuza inanıyorsanız, etkilenen URL veya uç noktayı, yeniden üretme adımlarını ve gördüğünüz etkiyi contact@bitculator.com adresine e-postayla gönderin. Üç iş günü içinde yanıt alırsınız.

Lütfen raporu düzeltilene kadar gizli tutun, size ait olmayan verilere erişmeyin ya da onları değiştirmeyin ve üretim ortamına karşı hizmet reddi saldırısı veya otomatik tarama çalıştırmayın. Bu koşullar altında iyi niyetle yapılan bildirimler yasal işlemle karşılanmaz. Ücretli bir ödül programı yoktur; istek üzerine adınız anılır.

Aynı iletişim bilgisi /.well-known/security.txt adresinde (RFC 9116) makine tarafından okunabilir biçimde yayımlanır.

Durum ve olaylar

Canlı bileşen durumu, açık olaylar ve son 30 günün kesintileri durum sayfasında ve /status.json adresinde yer alır.