Sur la plupart des pages de documentation, un résumé de l'explorateur d'API est visible à droite de l'écran. Si APIs Explorer n'est pas visible, cliquez sur Essayer pour afficher la version réduite d'APIs Explorer.
Si Essayer ne s'affiche pas sur la droite d'une page de documentation de référence, cela signifie qu'elle n'est pas compatible avec API Explorer. Par exemple, APIs Explorer n'est pas compatible avec les API nécessitant des comptes de service. Par conséquent, il ne figure 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 cURL, HTTP et éventuellement d'autres exemples de code. Pour afficher la version développée d'APIs Explorer, cliquez sur Plein écran .
Exécuter une méthode
API Explorer vous permet d'indiquer les paramètres obligatoires, les paramètres facultatifs et, le cas échéant, un corps de requête pour les méthodes d'API. 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 n'exige qu'un paramètre de requête (q) pour répertorier les livres. Pour essayer la méthode books.volumes.list, procédez comme suit:
- 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 demande de sélectionner un compte Google.
- (Facultatif) Une boîte de dialogue d'autorisation Google vous demande si vous pouvez gérer vos livres. Cliquez sur Allow (Autoriser). Les résultats apparaissent sous le bouton "Exécuter".
Si APIs Explorer affiche un résultat de 200, cela signifie que la méthode a bien été effectuée.
Résoudre les problèmes liés à APIs Explorer
Vous avez reçu une erreur 401 ou 403
Si vous obtenez une erreur 401 ou 403 lors de l'exécution d'une méthode à l'aide d'APIs Explorer, cela est probablement dû à l'un des problèmes suivants:
- Vous n'utilisez pas le bon type d'autorisation (clé API au lieu d'OAuth 2.0). Essayez de modifier 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 autoriser l'accès à vos données privées. Si votre navigateur bloque les pop-ups, cette fenêtre pop-up ne s'affiche pas et vous ne pouvez pas accorder l'accès.
Si vous cliquez sur Autoriser dans la boîte de dialogue d'autorisation et que rien ne se produit, essayez de modifier les paramètres de la fenêtre pop-up de votre navigateur pour activer les pop-up.