Sur la plupart des pages de documentation, un explorateur d'API condensé est visible sur la droite de l'écran. Si l'explorateur d'API n'est pas visible, cliquez sur Essayer pour afficher la version condensée de l'explorateur d'API.
Si l'option Essayer ne s'affiche pas à droite d'une page de documentation de référence, cela signifie que la méthode n'est pas compatible avec APIs Explorer. Par exemple, APIs Explorer n'est pas compatible avec les API qui nécessitent des comptes de service. Il n'apparaît donc pas sur les pages de documentation de ces API.
Afficher la version développée d'APIs Explorer
La version développée d'APIs Explorer contient des exemples de code cURL, HTTP et éventuellement d'autres. Pour afficher la version développée d'APIs Explorer, cliquez sur Plein écran .
Exécuter une méthode
APIs Explorer vous permet de saisir les paramètres obligatoires et facultatifs, ainsi qu'un corps de requête pour les méthodes d'API, le cas échéant. Pour de nombreuses méthodes REST, telles que les méthodes de liste, il vous suffit de remplir un ou deux champs avant de pouvoir exécuter la méthode. Par exemple, la méthode books.volumes.list de l'API Books ne nécessite qu'un paramètre de requête (q) pour lister les livres. Pour essayer la méthode books.volumes.list :
- Accédez à
books.volumes.list. - Si l'explorateur d'API ne s'affiche pas, cliquez sur Essayer.
- Dans le champ
q, saisissez Hunger Games (sans guillemets ni caractères spéciaux). - Faites défiler la page vers le bas, puis cliquez sur Exécuter.
- (Facultatif) Un écran de connexion Google vous invite à sélectionner un compte Google.
- (Facultatif) Une boîte de dialogue d'autorisation Google vous demande si vous souhaitez "Gérer vos livres". Cliquez sur Autoriser. Les résultats s'affichent sous le bouton "Exécuter".
Si APIs Explorer affiche un résultat de 200, cela signifie que la méthode a réussi.
Résoudre les problèmes liés à APIs Explorer
Vous avez reçu une erreur 401 ou 403
Si vous recevez une erreur 401 ou 403 lorsque vous exécutez une méthode à l'aide d'APIs Explorer, cela est probablement dû à un problème lié à l'un des éléments suivants :
- Vous utilisez le mauvais type d'autorisation (clé API au lieu d'OAuth 2.0). Essayez de changer le type d'autorisation.
- Vous utilisez OAuth 2.0, mais avec un champ d'application trop restreint. Essayez d'utiliser un champ d'application plus large.
La boîte de dialogue d'autorisation ne s'affiche pas
APIs Explorer utilise un pop-up pour accorder l'accès à vos données privées. Si votre navigateur bloque les pop-ups, celui-ci ne s'affichera pas et vous ne pourrez pas accorder l'accès.
Si vous cliquez sur Autoriser dans la boîte de dialogue d'autorisation et que rien ne se passe, essayez de modifier les paramètres des pop-ups de votre navigateur pour les activer.