Pour commencer
Versionnage et dépréciation
Comprenez les versions majeures dans l’URL, les ajouts compatibles, les avis de dépréciation et les périodes de fin de vie.
Chemins majeurs stables
Les intégrations client utilisent une version majeure dans l’URL, actuellement /api/v1. Le champ OpenAPI info.version, basé sur une date, identifie le contrat publié exact au sein de cette version majeure.
Changements compatibles
SendHQ peut ajouter, au sein de v1, des champs de requête facultatifs, des champs de réponse, des valeurs d’enum lorsque le schéma le permet, ainsi que de nouvelles opérations. Les clients doivent ignorer les champs de réponse inconnus et éviter de considérer une enum comme définitivement fermée, sauf si le schéma l’indique.
Changements incompatibles
Tout changement incompatible de requête, de réponse, d’authentification ou de comportement exige un nouveau chemin majeur tel que /api/v2, une documentation de migration et une transition annoncée. L’API v1 actuelle n’est pas dépréciée.
Dépréciation et fin de vie
Lorsqu’une version est dépréciée, SendHQ documente la solution de remplacement et le chemin de migration, et renvoie les en-têtes Deprecation et Sunset le cas échéant. Les versions dépréciées restent disponibles au moins 90 jours après la date de dépréciation publiée, sauf si leur maintien crée un risque urgent de sécurité ou juridique.