Passer au contenu principal
L’Automation API utilise le versionnement sémantique.

​
À propos du versionnement de l’API entière

Les changements majeurs (breaking changes) ne se produisent que dans les nouvelles versions majeures de l’API, à l’exception des cas suivants :
  • Les endpoints qui ne sont pas encore utilisés peuvent contenir des changements majeurs dans une version mineure (1.x).
  • Les correctifs de sécurité critiques qui rompent la rétrocompatibilité peuvent être publiés dans une version mineure. Consultez tous les changements de l’API dans le changelog.
Les changements majeurs incluent les types de modifications suivants :
  • Suppression complète d’une opération.
  • Suppression ou renommage d’un paramètre.
  • Suppression ou renommage d’un champ de réponse.
  • Ajout d’un nouveau paramètre requis.
  • Rendre obligatoire un paramètre auparavant optionnel.
  • Modification du type d’un paramètre ou d’un champ de réponse.
  • Suppression de valeurs d’énumération.
  • Ajout d’une nouvelle règle de validation à un paramètre existant.
  • Modification des exigences d’authentification ou d’autorisation.
Tout changement additif (non majeur) sera disponible dans toutes les versions d’API prises en charge. Les changements additifs sont des changements qui ne devraient pas casser une intégration. Les changements additifs incluent :
  • L’ajout d’une opération.
  • L’ajout d’un paramètre optionnel.
  • L’ajout d’un en-tête de requête optionnel.
  • L’ajout d’un champ de réponse.
  • L’ajout d’un en-tête de réponse.
  • L’ajout de valeurs d’énumération.
Lorsque Kameleoon publie une nouvelle version majeure de l’API, la version précédente reste prise en charge pendant au moins trois mois.

​
Spécifier une version d’API

Par défaut, https://api.kameleoon.com utilise la version la plus récente de l’API. Spécifiez une version en l’incluant dans l’URL (par exemple, https://api.kameleoon.com/v1/). La prochaine version majeure sera disponible à https://api.kameleoon.com/v2 une fois publiée.

​
À propos du versionnement par endpoint

Certains endpoints prennent en charge la spécification de version. Par exemple, une version plus récente d’un endpoint spécifique peut être préférée à la version par défaut de l’API. Lorsqu’il est disponible, utilisez le paramètre version pour spécifier la version souhaitée de l’endpoint. Lorsqu’une nouvelle version majeure est publiée, toutes les versions précédentes sont supprimées. Par exemple, si un endpoint a une version 1 et une version 2 dans la version 1.0.0 de l’API, la version 2.0.0 de l’API ne contient que la dernière version de cet endpoint.