Guide de l’Explorateur de l’API Graph

Usages courants

• Générer rapidement des token d’accès
• Obtenir des exemples de code de requêtes que vous avez exécutées
• Générer des informations de débogage à inclure dans les demandes d’assistance
• Tester les requêtes d’API avec les paramètres de production de votre application, y compris les autorisations, les fonctionnalités et les paramètres de vos cas d’utilisation
• Tester les requêtes d’API quand votre application est en test ou en développement à l’aide des autorisations et des fonctionnalités sur les utilisateur·ices ou les données test

Conditions requises

• Un compte de développeur·se Facebook
• Une application dans laquelle vous avez un rôle d’administration, de développement ou de test

Composants

Token d’accès

Lorsque vous obtenez un token d’accès, il apparaît en haut à droite de l’outil. Il s’agit du token qui sera inclus dans votre requête d’API Graph. Copiez ce token pour tester votre code dans votre application.

Cliquez sur l’icône d’informations pour afficher des détails sur le token actuel, notamment l’application à laquelle il est lié, et toutes les autorisations accordées par la personne qui l’utilise actuellement (vous, en l’occurrence).

Vous pouvez générer un nouveau token d’accès s’il a expiré ou si vous ajoutez de nouvelles autorisations.

Application Meta

Le menu déroulant de l’application Meta en haut à droite affiche toutes les applications sur lesquelles vous avez un rôle d’administration, de développement ou de test. Utilisez le menu déroulant pour sélectionner les paramètres à tester.

Utilisateur ou Page

Le menu déroulant Utilisateur ou Page vous permet d’obtenir et d’échanger des tokens d’accès Application, Utilisateur et Page pour l’application actuellement sélectionnée. Il sert aussi à désinstaller votre application de votre nœud Utilisateur, ce qui détruit le token d’accès actuel.

Autorisations

Chaque fois que vous demandez un token d’accès Utilisateur, une seule autorisation est donnée par défaut, public_profile. Le menu déroulant Autorisation vous permet de sélectionner des autorisations des données utilisateur·ices telles que email et user_photos, Évènements, Groupes et Autorisations des Pages, telles que manage_pages et ads_management, et Autres autorisations, telles que les autorisations instagram_basic et publish_video. Ceci permet à l’utilisateur·ice actuel·le de l’application (vous, en l’occurrence) d’accorder les autorisations spécifiques à l’application. Veillez à n’accorder que les autorisations dont votre application a besoin.

Si votre application est en développement, vous pouvez lui accorder n’importe quelle autorisation et vos requêtes la respecteront pour les données détenues par les personnes disposant d’un rôle dans votre application. Si votre application est en ligne, toutefois, accorder une autorisation pour laquelle votre application n’a pas été approuvée par le processus de Contrôle app fera échouer votre requête lorsque vous la soumettrez.

Champ de chaîne de requête

Lorsque vous ouvrez l’outil pour la première fois, une requête par défaut apparaît. Pour la modifier, saisissez-en une nouvelle ou recherchez des champs et sélectionnez-les dans la visionneuse de champs après l’exécution de la requête. Vous pouvez aussi utiliser les menus déroulants pour changer de méthode de fonctionnement et de version cible de l’API Graph.

Si vous cliquez sur l’icône de l’étoile à la fin du champ, la requête est enregistrée dans les favoris. Vous pouvez voir vos requêtes préférées en cliquant sur l’icône de livre.

Visionneuse de champ de nœud

Lorsque vous soumettez une requête GET sur un nœud, la visionneuse de champs située à gauche de la fenêtre affiche le nom du nœud et les champs renvoyés par l’API Graph. Pour modifier votre requête, recherchez et sélectionnez de nouveaux champs, cliquez sur l’icône « + » (plus), choisissez parmi les champs disponibles ou désélectionnez les champs inutiles. Ces actions mettent à jour votre requête de manière dynamique dans le champ de chaîne de cette dernière.

Fenêtre de réponse

La réponse à la dernière requête envoyée apparaît sous la chaîne de la requête.

Obtenir le code

Si vous êtes satisfait de votre requête, cliquez sur le bouton Obtenir le code, en bas au centre sous la réponse, pour générer un code échantillon basé sur cette requête. En général, vous ne pourrez pas copier et coller l’échantillon de code directement dans votre base de code, mais cette fonction vous donne un point de départ utile.

Copier les informations de débogage

En cas d’échec de votre requête, si vous ne parvenez pas à en trouver la raison et décidez de contacter l’assistance dédiée au développement, cliquez sur ce bouton en bas au centre pour copier les détails de votre requête et de la réponse dans votre presse-papiers. Vous pouvez nous envoyer ces informations avec votre demande d’assistance afin de nous aider à comprendre ce qui se passe.

Enregistrer la session

Cliquez sur le bouton Enregistrer la session en bas au centre pour enregistrer l’état de votre requête, avec le token d’accès supprimé. N’oubliez pas d’inclure le lien vers cette session si vous décidez de contacter l’Assistance de développement.

Exemple de requête

Essayez d’exécuter la requête par défaut qui s’affiche lorsque vous charger l’Explorateur de l’API Graph pour la première fois. Si vous ne l’avez pas encore fait, ouvrez l’Explorateur de l’API Graph dans une nouvelle fenêtre, sélectionnez l’application que vous souhaitez tester dans le menu déroulant de l’application et récupérez un token d’accès utilisateur·ice.

La requête par défaut apparaît dans le champ de chaîne de la requête :

GET https://developers.facebook.com/v21.0/me?fields=id,name

La requête par défaut demande les champs id et name sur le nœud /me, qui est un nœud spécial qui oriente soit vers le nœud /User, soit vers le nœud /Page identifié par le token. Étant donné que vous utilisez un token d’accès Utilisateur, cela a pour effet d’établir une association vers votre nœud Utilisateur.

Les champs id et name sont disponibles au public et peuvent être renvoyés si l’utilisateur·ice a accordé à votre application l’autorisation default ou l’autorisation public_profile. Ces autorisations sont pré-approuvées pour toutes les applications (vous pouvez confirmer les approbations en cliquant sur l’icône d’informations dans le champ Token d’accès). Vous n’avez donc pas à accorder d’autres autorisations à votre application pour que la requête fonctionne. Cliquez sur Obtenir un token d’accès et confirmez que vous souhaitez accorder à votre application l’accès à vos informations utilisateur·ice accessibles au public.

Soumettez votre requête : votre identifiant utilisateur d’application spécifique et votre nom doivent apparaître dans la fenêtre de la réponse.