La section "Identifiants" d'APIs Explorer vous permet de tester différents identifiants et différents niveaux d'accès. Cette fonctionnalité est utile pour vous assurer d'utiliser 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 Clé API sont cochés. Si vous ne souhaitez effectuer le test qu'avec un seul identifiant, cochez le type d'identifiant à utiliser (et décochez l'autre type d'identifiant). Voici les règles générales pour choisir des identifiants à tester :
Si vous utilisez une méthode pour accéder à des données publiques, telles que les 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, cela signifie que les identifiants sont suffisants pour accéder aux données. Si vous obtenez un résultat 401, vous devez utiliser des identifiants OAuth 2 pour accéder aux données.
Tester avec différents niveaux d'accès
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 appartenant aux utilisateurs. Idéalement, vous souhaitez que votre application utilise des niveaux d'accès avec le niveau d'accès le plus restreint aux données de l'utilisateur. Différentes méthodes peuvent nécessiter des niveaux d'accès différents. Par exemple, une méthode d'une API peut nécessiter au moins un champ d'application en lecture seule, tandis que d'autres méthodes peuvent nécessiter un champ d'application en lecture et en écriture.
Par défaut, tous les champs d'application Google OAuth 2.0 pour une API sont activés dans APIs Explorer. Pour effectuer un test avec un champ d'application spécifique :
- Dans la section "Identifiants Google OAuth 2.0", cliquez sur Afficher les champs d'application.
- Vérifiez le champ d'application à utiliser lors de l'appel de la méthode.
- Cliquez sur Exécuter pour exécuter l'API en utilisant uniquement le champ d'application sélectionné. L'explorateur d'API affiche un écran d'autorisation vous demandant d'accorder l'accès pour utiliser le champ d'application.
- Cliquez sur Autoriser. Les résultats s'affichent sous le bouton "Exécuter".
Si l'explorateur d'API affiche un résultat de 200 sous "application/json", cela signifie que le champ d'application est suffisant pour appeler la méthode. Si l'explorateur d'API affiche un résultat 403, cela signifie que vous avez choisi un champ d'application insuffisant pour appeler la méthode. Essayez une portée plus large.
Pour en savoir plus sur la sélection des habilitations, 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 tester avec de nouveaux champs d'application
Une fois que vous avez utilisé l'écran d'autorisation Google pour approuver l'autorisation, l'explorateur d'API reste autorisé à effectuer des requêtes authentifiées tant que les identifiants ne sont pas expirés. Si vous décochez des autorisations, les identifiants et les autorisations précédemment approuvés ne sont pas réinitialisés. Si vous souhaitez effectuer des tests avec une nouvelle configuration de portée, vous devez révoquer les identifiants que vous avez approuvés précédemment.
Pour révoquer les identifiants utilisés par APIs Explorer :
- Accédez à Applications ayant accès à votre compte.
- Sous Applications tierces ayant accès au compte, cliquez sur Google APIs Explorer.
- Cliquez sur Supprimer l'accès.
- (Facultatif) Actualisez la page de documentation pour réinitialiser l'explorateur d'API.