Gestion des versions
Comment l’API évolue, et comment nous vous en informons.
La version figure dans le chemin : /api/v1.
Dans la v1, nous n’apportons que des modifications qui ne cassent pas une intégration correcte :
- nouveaux points de terminaison ;
- nouveaux champs facultatifs dans les requêtes ;
- nouveaux champs dans les réponses ;
- nouveaux codes d’erreur et nouvelles valeurs de
status.
Lisez les réponses avec tolérance : ignorez les champs que vous ne connaissez pas.
Une modification incompatible fait l’objet d’une nouvelle version (/api/v2). Nous l’annonçons à l’avance aux titulaires de comptes d’API.
La description de l’API lisible par machine se trouve à l’adresse /api/v1/openapi.json, pour Postman ou un générateur de client.