Aperçu

L'explorateur d'API Google est un outil disponible sur la plupart des pages de documentation de la méthode API REST, qui vous permet d'essayer les méthodes d'API Google sans écrire de code. L'explorateur d'API agit sur des données réelles. Par conséquent, soyez prudent lorsque vous essayez de créer, de modifier ou de supprimer des données.

Utiliser l'annuaire

Pour obtenir la liste des API Google que vous pouvez explorer, accédez à l'annuaire des API Google Explorer. Cette liste contient des liens vers la documentation de référence des API compatibles. Pour explorer l'API, procédez comme suit:

  1. Ouvrez l'annuaire des API Google Explorer.
  2. Dans le champ de recherche situé en haut, saisissez le nom de l'API que vous souhaitez explorer.
  3. Cliquez sur le nom de l'API. La documentation de référence de l'API s'ouvre.
  4. Sur la gauche, cliquez sur la méthode que vous souhaitez utiliser dans le menu de navigation.

  5. Sur la droite, recherchez le panneau intitulé "Essayez cette méthode". Pour en savoir plus sur l'utilisation du panneau latéral d'APIs Explorer et pour le développer dans le panneau plein d'APIs Explorer, consultez les informations ci-dessous.

Utiliser le panneau latéral

Panneau latéral API Explorer pour l'API Google Livres
Figure 1 : Panneau latéral d'APIs Explorer pour l'API Google Livres

Par défaut, APIs Explorer s'affiche à droite de l'écran dans la documentation de référence de l'API pour les méthodes compatibles.

Vous pouvez personnaliser les sections suivantes et interagir avec elles dans le panneau latéral de l'explorateur d'API:

  • Paramètres de requête, si requis par la méthode.
  • Corps de la requête, si la méthode l'exige.
  • Identifiants, pour tester la méthode avec différents types et champs d'application des identifiants
  • Exécuter, pour exécuter la méthode à l'aide des paramètres que vous avez spécifiés.
  • Résultat, qui ne s'affiche qu'après l'exécution de la méthode.

Utiliser le panneau plein écran

Panneau plein écran d'APIs Explorer pour l'API Google Livres
Figure 2 : Panneau plein écran d'APIs Explorer pour l'API Google Livres

Dans le panneau latéral d'APIs Explorer, vous pouvez cliquer sur Plein écran pour développer APIs Explorer. Le panneau plein écran affiche un volet supplémentaire contenant des exemples de code, des réponses application/json et des réponses HTTP brutes.

Authentification

L'explorateur d'API utilise ses propres identifiants pour effectuer une requête. Vous ne pouvez pas utiliser les identifiants personnalisés avec l'explorateur d'API.

Formats de données

APIs Explorer n'accepte que JSON pour les réponses et les charges utiles de requêtes. Même si votre API est compatible avec d'autres formats de données, ceux-ci ne fonctionnent pas dans l'explorateur d'API.

Étapes suivantes