singlefax
Idioma

Versões e descontinuação da API do SingleFax

Agentes e sistemas de backend podem se basear nesta política. A API REST atual é /api/v1. Não há data prevista para encerrar seu suporte.

Versionamento

A versão da API REST pública aparece no caminho da URL: https://singlefax.com/api/v1/…, com os mesmos caminhos em api.singlefax.com. O documento OpenAPI está em /openapi.json, com info.version correspondente à versão principal do caminho, atualmente 1.0.0.

Alterações compatíveis com versões anteriores — novos campos opcionais, endpoints e valores de erro data.code — permanecem na v1 sem exigir um cabeçalho. Alterações incompatíveis, como remover campos, mudar tipos ou exigir nova autenticação, são lançadas como /api/v2. Não mudamos sem aviso a estrutura das solicitações ou respostas da v1.

Descontinuação e fim de suporte

Quando uma operação ou um campo da v1 estiver prestes a ser removido, as respostas dessa operação incluirão RFC 8594 Deprecation, com a data do aviso, e RFC 8594 Sunset, com a data em que deixará de funcionar. Sunset será pelo menos 90 dias após Deprecation. O OpenAPI marca as mesmas operações com deprecated: true.

Atualmente, nenhuma operação da v1 inclui os cabeçalhos Deprecation ou Sunset. O MCP Streamable HTTP em /mcp aplica o mesmo prazo de aviso se uma ferramenta for removida.

Onde consultar estas informações por código