Mise à niveau vers la dernière version de l’API Graph
Ce guide explique comment préparer votre application à tester différentes versions de l’API Graph et à fonctionner avec sa dernière version.
L’outil de mise à niveau de l’API montre les appels d’API effectués à partir de votre application qui peuvent être concernés par les modifications dans les versions plus récentes de l’API. Vous pouvez voir rapidement les modifications nécessaires pour passer de votre version actuelle à une version plus récente.
Déterminer l’incidence d’une modification sur votre application
L’outil de mise à niveau de l’API affiche une liste personnalisée des modifications qui affectent une application lorsqu’elle est mise à niveau vers une version cible spécifiée. Ceci vous permet d’afficher l’ensemble des modifications pertinentes entre les versions source et cible.
Étape 1 : dans l’outil de mise à niveau, sélectionnez votre application dans le menu déroulant ou saisissez le nom de votre application.
La liste du menu déroulant affiche jusqu’à dix applications. Pour afficher d’autres applications que celles qui sont répertoriées, utilisez la barre de recherche dans le menu déroulant.
Étape 2 : utilisez les menus déroulants à droite pour sélectionner la version à partir de laquelle vous souhaitez effectuer la mise à niveau (Upgrade from) et la version vers laquelle vous souhaitez effectuer la mise à niveau (Upgrade to).
Lire les résultats
L’outil affiche le nombre de modifications devant être apportées pour mettre à niveau votre application vers la version sélectionnée. Si votre application effectue des appels d’API qui ne seront pas affectés par une nouvelle version, aucune donnée n’est renvoyée.
Les méthodes sont codées à l’aide de couleurs selon la version ayant un impact sur l’appel. Passez la souris sur l’histogramme pour afficher le nombre de modifications requises pour chaque version. Les dates associées à chaque version désignent les dates auxquelles les modifications seront appliquées pour toutes les applications.
Le tableau affiche le type de modification (dépréciation, nouvelle fonctionnalité ou modification), les méthodes affectées, le nombre d’appels effectués les sept derniers jours et le pourcentage d’appels d’API affecté par la modification en question.
Limitations
- Pour visualiser l’application dans l’outil, vous devez être admin ou développeur·euse de celle-ci.
- Aucune donnée n’est renvoyée si votre application a effectué aucun ou trop peu d’appels d’API avec la version à partir de laquelle vous effectuez la mise à niveau.
- Le volume des appels peut sembler incorrect. L’enregistrement des appels d’API est échantillonné puis agrégé au cours de la semaine précédente. Il est ensuite comparé au volume d’appels afin d’estimer le nombre d’appels susceptibles d’être affectés par un changement de version donné.
Remarque : Certaines modifications n’affectent pas nécessairement chaque appel d’API. Faites preuve de discernement pour savoir si une modification particulière doit être gérée par votre application. Testez vos appels d’API dans la nouvelle version et assurez-vous qu’ils fonctionnent correctement.
Mettre en œuvre une nouvelle version
Dans Espace App, sous Paramètres > Avancés, faites défiler la page jusqu’à la section Mettre à niveau la version de l’API.
Mettre à niveau les développeur·euses et les admins
Cette option met à niveau tous les développeur·euses et admins d’une application vers la version disponible suivante. Cela vous permet de tester des modifications sur un échantillon réduit d’utilisateurs réels avant de lancer la nouvelle version pour tous les utilisateurs.
Mettre à niveau tous les appels
Cette option met à niveau tous les appels effectués par une application vers la version disponible suivante. Procéder à une mise à niveau précoce se révèle utile, dans la mesure où cela vous permet de revenir à la version initiale en cas de bugs ou de problèmes imprévus.
En savoir plus
- Changelog de l’API Graph : découvrez les modifications apportées à la dernière version.
- Gestion des versions : obtenez des informations détaillées sur la gestion des versions de l’API Graph, les requêtes concernant différentes versions, etc.
- Applications tests : créez des applications tests pour essayer des modifications dans votre application avant de la rendre disponible à tous.
- Utilisateurs tests : créez des utilisateurs tests pour essayer des modifications dans votre application avant de la rendre disponible à tous.