Aperçu

Google APIs Explorer est un outil disponible sur la plupart des pages de documentation sur les méthodes de l'API REST. Il vous permet d'essayer les méthodes des API Google sans écrire de code. APIs Explorer agit sur des données réelles. Soyez donc 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, consultez 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 le répertoire des API de Google.
  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. À gauche, cliquez sur la méthode que vous souhaitez utiliser dans la navigation.
  5. À droite, recherchez le panneau intitulé "Essayez cette méthode". Pour en savoir plus sur l'utilisation du panneau latéral APIs Explorer et sur son développement en plein écran, consultez la section ci-dessous.

Utiliser le panneau latéral

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

Par défaut, APIs Explorer s'affiche sur le côté droit de l'écran dans la documentation de référence de l'API pour connaître les méthodes compatibles.

Vous pouvez personnaliser les sections suivantes et interagir avec elles dans le panneau latéral d'APIs Explorer:

  • Paramètres de requête, si la méthode l'exige.
  • Corps de la requête, si la méthode l'exige.
  • Credentials (Identifiants) pour tester la méthode avec différents types et habilitations d'identifiants.
  • Bouton Exécuter pour exécuter la méthode à l'aide des paramètres que vous avez spécifiés.
  • Résultat, affiché uniquement après l'exécution de la méthode.

Utiliser le panneau plein écran

Panneau plein écran de l'API Google Livres
Figure 2 : Panneau plein écran de l'explorateur d'API pour l'API Google Livres

Dans le panneau latéral d'APIs Explorer réduit, 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

APIs Explorer utilise ses propres identifiants pour effectuer une requête. Vous ne pouvez pas utiliser les identifiants personnalisés avec APIs Explorer.

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