Tester avec différents types d'identifiants et portées

La section des identifiants d'APIs Explorer vous permet de tester différents identifiants et champs d'application. Cette fonctionnalité est utile pour vous assurer que vous utilisez les identifiants et le champ d'application minimaux requis pour appeler un point de terminaison d'API.

Tester avec différents identifiants

Par défaut, les types d'identifiants OAuth 2 et de la clé API sont cochés. Si vous souhaitez effectuer des tests avec un seul identifiant, cochez le type d'identifiants à utiliser (et décochez l'autre). Vous trouverez ci-dessous les règles générales à suivre pour choisir un identifiant à tester:

  • Si vous utilisez une méthode pour accéder à des données publiques, telles que des données Google Maps, vous pouvez utiliser une clé API comme identifiant. Cochez Clé API et décochez Google OAuth 2.0.

  • Si vous utilisez une méthode pour accéder à des données privées, telles que les données Google Drive de l'utilisateur, vous devez utiliser un identifiant OAuth 2. Décochez Clé API et cochez Google OAuth 2.0.

Si vous obtenez un résultat de 200, l'identifiant est suffisant pour accéder aux données. Si vous recevez un résultat d'erreur 401, vous devez utiliser les identifiants OAuth 2 pour accéder aux données.

Tester avec différentes habilitations

Un champ d'application est une chaîne telle que https://www.googleapis.com/auth/drive.metadata.readonly qui définit un niveau d'accès aux ressources requises par votre application, comme le niveau d'accès aux données détenues par les utilisateurs. Idéalement, votre application utiliserait des champs d'application avec le niveau d'accès le plus restreint aux données de l'utilisateur. Différentes méthodes peuvent nécessiter des champs d'application différents. Par exemple, une méthode dans une API peut nécessiter au moins une portée en lecture seule, tandis que d'autres peuvent nécessiter un niveau en lecture/écriture.

Par défaut, tous les niveaux d'accès Google OAuth 2.0 d'une API sont activés dans l'explorateur d'API. Pour effectuer un test avec un champ d'application spécifique, procédez comme suit:

  1. Dans la section "Identifiants" de Google OAuth 2.0, cliquez sur Afficher les champs d'application.
  2. Vérifiez la portée à utiliser lorsque vous appelez la méthode.
  3. Cliquez sur Exécuter pour exécuter l'API en utilisant uniquement le champ d'application sélectionné. APIs Explorer affiche un écran d'autorisation vous demandant d'accorder l'accès pour utiliser le champ d'application.
  4. Cliquez sur Allow (Autoriser). Les résultats apparaissent sous le bouton "Exécuter".

Si APIs Explorer affiche un résultat de 200 sous &&t;application/json", le champ d'application suffit pour appeler la méthode. Si API Explorer affiche un résultat de 403, vous avez choisi un champ d'application insuffisant pour appeler la méthode. Essayez un champ d'application plus large.

Pour en savoir plus sur la sélection du niveau d'accès, consultez la section sur l'authentification et l'autorisation de la documentation de votre API Google spécifique.

Révoquer l'accès autorisé pour effectuer des tests avec de nouveaux champs d'application

Après avoir utilisé l'écran d'autorisation de Google pour approuver l'autorisation, APIs Explorer reste autorisé à effectuer des requêtes authentifiées tant que les identifiants n'ont pas expiré. Le fait de décocher les champs d'application ne réinitialise pas les identifiants et les champs d'application précédemment approuvés. Si vous souhaitez effectuer un test avec une nouvelle configuration de champ d'application, vous devez révoquer vos identifiants précédemment approuvés.

Pour révoquer les identifiants utilisés par APIs Explorer:

  1. Accédez à Applications ayant accès à votre compte.
  2. Sous Applications tierces ayant accès au compte de votre enfant, cliquez sur Google APIs Explorer.
  3. Cliquez sur Supprimer l'accès.
  4. (Facultatif) Actualisez la page de documentation pour réinitialiser APIs Explorer.