Skip to main content
La version majeure figure dans le chemin : /v1. Au sein de /v1, le contrat n’évolue que de façon additive :
  • de nouveaux points de terminaison ;
  • de nouveaux paramètres de requête facultatifs ;
  • de nouveaux champs dans les réponses ;
  • de nouveaux codes d’erreur pour de nouvelles situations.
Construisez votre client pour que ces ajouts ne le cassent jamais : ignorez les champs de réponse que vous ne connaissez pas, et traitez un code d’erreur inconnu selon son statut HTTP.

​
Changements incompatibles

Tout le reste est un changement incompatible : retirer ou renommer un champ ou un point de terminaison, modifier le type ou le sens d’un champ, ajouter une valeur à une énumération existante telle que status, ou rendre un paramètre obligatoire. Un changement incompatible est annoncé au moins 6 mois à l’avance dans le journal des modifications, avec ce qui change, ce que vous devez faire et la date au plus tôt à laquelle l’ancien comportement disparaît. Lorsque c’est possible, il est livré sous la forme d’une nouvelle version majeure (/v2), tandis que /v1 continue de fonctionner jusqu’à cette date.

​
Où les changements sont annoncés

Chaque changement publié de l’API fait l’objet d’une entrée datée dans le journal des modifications. La production et le staging évoluent ensemble, et le staging est mis à jour en premier.