singlefax
Langue

Versionnement et dépréciation de l’API SingleFax

Les agents et services backend peuvent s’appuyer sur cette politique. L’interface REST actuelle est /api/v1. Aucun retrait n’est prévu.

Gestion des versions

L’API REST publique est versionnée dans le chemin d’URL : https://singlefax.com/api/v1/…, avec les mêmes chemins sur api.singlefax.com. OpenAPI est disponible à /openapi.json, avec info.version correspondant à la version majeure du chemin, actuellement 1.0.0.

Les ajouts rétrocompatibles, comme de nouveaux champs facultatifs, points d’accès ou valeurs d’erreur data.code, restent en v1 sans en-tête. Les changements incompatibles, suppressions de champs, types modifiés ou nouvelles exigences d’authentification sortent en /api/v2. Nous ne modifions pas silencieusement la structure des requêtes ou réponses v1.

Deprecation et Sunset

Lorsqu’une opération ou un champ v1 doit disparaître, ses réponses incluent les en-têtes RFC 8594 Deprecation, date de l’annonce, et RFC 8594 Sunset, date d’arrêt. Sunset intervient au moins 90 jours après Deprecation. OpenAPI marque ces mêmes opérations avec deprecated: true.

Aucune opération v1 ne porte actuellement Deprecation ou Sunset. MCP Streamable HTTP à /mcp respecte le même préavis en cas de suppression d’un outil.

Sources lisibles par machine