singlefax
Dil

SingleFax API sürümleme ve kullanımdan kaldırma

Ajanlar ve sunucu uygulamaları bu ilkeye güvenebilir. Mevcut REST API sürümü /api/v1. Kullanımdan kaldırılması için belirlenmiş bir tarih yoktur.

Sürüm yönetimi

Herkese açık REST API sürümü URL yolunda belirtilir: https://singlefax.com/api/v1/… ve api.singlefax.com üzerindeki aynı yollar. OpenAPI /openapi.json adresindedir; info.version, yolun ana sürümüyle eşleşir (şu anda 1.0.0).

Geriye uyumlu eklemeler (yeni isteğe bağlı alanlar, uç noktalar veya hata data.code değerleri), ek bir başlık gerektirmeden v1 kapsamında kalır. Geriye uyumluluğu bozan değişiklikler, kaldırılan alanlar, tür değişiklikleri veya yeni zorunlu kimlik doğrulama gereksinimleri /api/v2 olarak yayımlanır. v1 istek ve yanıt yapılarını haber vermeden değiştirmeyiz.

Deprecation ve Sunset

Bir v1 işlemi veya alanı kaldırılacaksa o işlemin yanıtları RFC 8594 Deprecation (kaldırma kararını işaretlediğimiz tarih) ve RFC 8594 Sunset (çalışmanın duracağı tarih) içerir. Sunset, Deprecation'dan en az 90 gün sonradır. OpenAPI aynı işlemleri deprecated: true ile işaretler.

Şu anda hiçbir v1 işlemi Deprecation veya Sunset taşımıyor. /mcp adresindeki MCP Streamable HTTP'de bir araç kaldırılırsa aynı bildirim süresi geçerlidir.

Makineyle okunabilir kaynaklar