Policy di versioning e deprecazione dell'API InsiderCat

InsiderCat versiona la sua API pubblica nel percorso URL (/api/v1/...). Questa pagina è la fonte di verità su cui agenti e sviluppatori possono fare affidamento per capire come funziona il versioning e come verrebbe segnalata un'eventuale deprecazione, così le integrazioni non devono indovinare.

Versione attuale

Versione: 1.0.0 (prefisso del percorso /api/v1)

Riferimento API · /openapi.json

Cosa costituisce una modifica non retrocompatibile

Non è una modifica non retrocompatibile: nuovi endpoint, nuovi parametri di query opzionali, nuovi campi di risposta.
Modifica non retrocompatibile, coperta da questa policy: rimuovere o rinominare un campo, cambiare il tipo di un campo o cambiare il comportamento predefinito di un endpoint esistente.

Come viene segnalata una deprecazione

Un endpoint deprecato riceve un preavviso minimo di 90 giorni prima della rimozione.
Durante questo periodo, le risposte dell'endpoint deprecato includono un header Deprecation e un header Sunset (RFC 8594) che indicano la data di rimozione, oltre a un header Link che rimanda a questa pagina e a un eventuale endpoint sostitutivo.
La deprecazione viene elencata qui sotto e annunciata sul portale sviluppatori.
I titolari di chiavi API registrate possono essere avvisati via email per le deprecazioni rilevanti.

Endpoint attualmente deprecati

Nessuno. Tutti gli endpoint /api/v1 sono pienamente supportati.

Portale sviluppatori Riferimento API Contatti

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