Dépréciation des API

Le passage d'un produit à l'état déprécié peut indiquer que:

• le produit d’API n’est plus mis à jour par notre équipe de développement;
• l’appel de l’API ne supporte plus certains cas;
• le temps réponse est trop long;
• l’API n’a plus l’efficacité attendue.

À partir de la journée où le produit est déprécié, vous avez 90 jours pour migrer vers le produit de remplacement.

Au bout de ces 90 jours, le produit est supprimé d'Espace API.

Pour facilement voir la différence entre une API dépréciée et une API de remplacement, vous pouvez récupérer le contenu de l'exemple de l'API dépréciée et le comparer avec l'exemple de la nouvelle API à l'aide d'un logiciel de comparaison comme Notepad++.
Vous pouvez aussi comparer le contenu des fichiers YAML à l'aide de NotePad++.

Lors de la migration de votre application vers le nouveau produit d'API, vous aurez possiblement des ajustements à faire dans votre code.

Lors de l'apparition d'un produit déprécié, vous serez notifié du produit de remplacement. Habituellement, il y a un changement de version majeure. Exemple d'un changement de version majeure: la version passe de 4.2.8 à 5.0.0.

Un changement de version mineure d'une API survient lorsque:

• il y a une mise à jour dans la documentation de l'API;
• une donnée est ajoutée sans que cela nuise à votre code, par exemple un nouveau paramètre de requête.

Exemple d'un changement de version mineure: la version passe de 4.0.0 à 4.1.0.