InsiderCat API Sürümleme ve Kullanımdan Kaldırma Politikası

InsiderCat, genel API'sini URL yolunda sürümler (/api/v1/...). Bu sayfa, sürümlemenin nasıl çalıştığı ve gelecekteki bir kullanımdan kaldırmanın nasıl bildirileceği konusunda ajanların ve geliştiricilerin güvenebileceği referans kaynaktır; böylece entegrasyonların tahmin yürütmesine gerek kalmaz.

Mevcut sürüm

Sürüm: 1.0.0 (yol öneki /api/v1)

API Referansı · /openapi.json

Neler kırıcı değişiklik sayılır

Kırıcı değil: yeni uç noktalar, yeni isteğe bağlı sorgu parametreleri, yeni yanıt alanları.
Kırıcı ve bu politika kapsamında: bir alanı kaldırmak veya yeniden adlandırmak, bir alanın türünü değiştirmek veya mevcut bir uç noktanın varsayılan davranışını değiştirmek.

Kullanımdan kaldırma nasıl bildirilir

Kullanımdan kaldırılan bir uç nokta, kaldırılmadan önce en az 90 gün önceden bildirilir.
Bu süre boyunca, kullanımdan kaldırılan uç noktadan gelen yanıtlar; kaldırma tarihini belirten bir Deprecation başlığı ve bir Sunset başlığı (RFC 8594) ile bu sayfaya ve varsa yerine geçen uç noktaya işaret eden bir Link başlığı taşır.
Kullanımdan kaldırma aşağıda listelenir ve geliştirici portalında duyurulur.
Kayıtlı API anahtarı sahipleri, önemli kullanımdan kaldırmalar için e-posta ile bilgilendirilebilir.

Şu anda kullanımdan kaldırılmış uç noktalar

Yok. Tüm /api/v1 uç noktaları tam olarak desteklenmektedir.

Geliştirici Portalı API Referansı İletişim

# InsiderCat API versioning and deprecation policy

InsiderCat versions its public API in the URL path (`/api/v1/...`). The current and only version is `v1`.

## Compatibility within v1

- Adding new endpoints, new optional query parameters, and new response fields is not a breaking change.
- Removing or renaming a field, changing a field's type, or changing default behavior is a breaking change and requires a deprecation notice under this policy (or a new API version).

## How deprecation is signaled

- A deprecated endpoint gets a minimum 90-day notice before removal.
- During that window, responses from the deprecated endpoint include a `Deprecation` header and a `Sunset` header (RFC 8594) naming the removal date, plus a `Link` header pointing back to this page and to any successor endpoint.
- The deprecation is also listed on this page and announced on the developer portal.
- Registered API key holders are notified by email at hi@insidercat.com's discretion for material deprecations.

## Currently deprecated endpoints

- None. All `/api/v1` endpoints are fully supported.

## Resources

- [Developer portal](/developers)
- [API reference](/api-mcp/docs)
- [OpenAPI JSON](/openapi.json)