Deactivation d'une API

11 juillet 2024

2 min read

Il y a des moments où vous devez cesser de servir une API. Cela peut être parce que vous voulez la remplacer par une nouvelle version plus performante, ou que les fonctionnalités fournies par l’API ne sont plus pertinentes. Quelles sont les étapes clés pour vous assurer que tous les utilisateurs cessent d’utiliser une API afin de pouvoir la désactiver en toute sécurité ?

Découverte des utilisateurs

J’ai envoyé un e-mail à chaque utilisateur pour leur demander pourquoi ils utilisaient l’API, quelle était l’importance de leur dépendance pour l’entreprise, et combien de temps il leur faudrait pour passer à la nouvelle API. Cette étape était cruciale car elle m’a permis de définir la durée pendant laquelle l’API devrait être en phase de dépréciation et la durée totale du processus de désactivation.

Dépréciation de l’API

J’ai défini une période de dépréciation de trois mois. L’idée était que dans les trois mois, tous les utilisateurs avaient adapté leur solution à l’utilisation de la nouvelle API. J’ai envoyé une communication à tous les utilisateurs, expliquant que l’API allait être dépréciée et qu’ils avaient trois mois pour s’intégrer à la nouvelle.

Coucher de soleil de l’API

À ce stade, et une fois que les trois mois se sont écoulés, il était temps de désactiver définitivement l’API. J’ai établi une période de coucher de soleil d’un mois. Au lieu de désactiver immédiatement l’API, j’ai pensé offrir un autre mois au cas où quelqu’un n’aurait pas eu assez de temps pour s’adapter.

Désactivation de l’API

Enfin, lorsque la date limite de coucher de soleil est arrivée, il était temps de désactiver l’API. Pour ce faire, j’ai configuré la passerelle API pour arrêter d’accepter les demandes vers les points de terminaison de l’API. À partir de ce moment-là, personne n’a pu faire de demandes à cette API. En résumé, les étapes que j’ai suivies ont commencé par limiter la consommation en bloquant les nouveaux utilisateurs, découvrir qui étaient les utilisateurs existants et établir un canal de communication, annoncer la dépréciation de l’API et créer une date limite, communiquer la date de coucher de soleil, et enfin bloquer tous les utilisateurs et désactiver l’API.