Política de versionado y desuso de la API de InsiderCat

InsiderCat versiona su API pública en la ruta de la URL (/api/v1/...). Esta página es la fuente de verdad en la que agentes y desarrolladores pueden confiar para entender cómo funciona el versionado y cómo se notificaría un futuro desuso, para que las integraciones no tengan que adivinar.

Versión actual

Versión: 1.0.0 (prefijo de ruta /api/v1)

Referencia de API · /openapi.json

Qué se considera un cambio disruptivo

No disruptivo: nuevos endpoints, nuevos parámetros de consulta opcionales, nuevos campos de respuesta.
Disruptivo, y cubierto por esta política: eliminar o renombrar un campo, cambiar el tipo de un campo o cambiar el comportamiento predeterminado de un endpoint existente.

Cómo se notifica un desuso

Un endpoint en desuso recibe un aviso mínimo de 90 días antes de su eliminación.
Durante ese período, las respuestas del endpoint en desuso incluyen un encabezado Deprecation y un encabezado Sunset (RFC 8594) que indican la fecha de eliminación, además de un encabezado Link que apunta de nuevo a esta página y a cualquier endpoint sucesor.
El desuso se enumera a continuación y se anuncia en el portal para desarrolladores.
Los titulares de claves API registradas pueden recibir una notificación por correo electrónico ante desusos importantes.

Endpoints actualmente en desuso

Ninguno. Todos los endpoints de /api/v1 están completamente soportados.

Portal para desarrolladores Referencia de API Contacto

# 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)