singlefax
Lingua

Versioni e dismissione dell'API SingleFax

Agenti e backend possono basarsi su questa politica. L'attuale interfaccia REST è /api/v1. Non è prevista alcuna dismissione.

Gestione delle versioni

L'API REST pubblica indica la versione nel percorso URL: https://singlefax.com/api/v1/… e gli stessi percorsi su api.singlefax.com. OpenAPI è disponibile su /openapi.json, con info.version corrispondente alla versione principale del percorso, attualmente 1.0.0.

Le aggiunte retrocompatibili, come campi facoltativi, nuovi endpoint e nuovi valori di errore data.code, restano su v1 senza un'intestazione. Modifiche incompatibili, rimozione di campi, cambio dei tipi o nuovi requisiti di autenticazione vengono pubblicati come /api/v2. Non cambiamo silenziosamente la struttura di richieste e risposte v1.

Deprecation e Sunset

Quando un'operazione o un campo v1 sta per essere rimosso, le risposte dell'operazione includono Deprecation RFC 8594, con la data di segnalazione, e Sunset RFC 8594, con la data in cui smetterà di funzionare. Sunset è almeno 90 giorni dopo Deprecation. OpenAPI contrassegna le stesse operazioni con deprecated: true.

Attualmente nessuna operazione v1 include Deprecation o Sunset. Per MCP Streamable HTTP su /mcp vale lo stesso preavviso in caso di rimozione di uno strumento.

Dove leggere queste informazioni automaticamente