Testar com diferentes tipos de credenciais e escopos

A seção de credenciais do APIs Explorer permite testar com diferentes credenciais e escopos. Esse recurso é útil para garantir que você está usando as credenciais e o escopo mínimos necessários para invocar um endpoint de API.

Testar com credenciais diferentes

Por padrão, os tipos de credenciais OAuth 2 e chave de API são marcados. Se você quiser testar com apenas uma credencial, marque o tipo de credencial a ser usado e desmarque o outro. Confira as regras gerais para escolher uma credencial para testar:

  • Se você estiver usando um método para acessar dados públicos, como os do Google Maps, use uma chave de API como sua credencial. Marque Chave de API e desmarque Google OAuth 2.0.

  • Se você estiver usando um método para acessar dados particulares, como os dados do Google Drive do usuário, use uma credencial do OAuth 2. Desmarque Chave de API e marque Google OAuth 2.0.

Se você receber um resultado 200, a credencial será suficiente para acessar os dados. Se você receber um resultado 401, use uma credencial OAuth 2 para acessar os dados.

Testar com diferentes escopos

Um escopo é uma string, como https://www.googleapis.com/auth/drive.metadata.readonly, que define um nível de acesso aos recursos necessários para seu app, como o nível de acesso aos dados dos usuários. O ideal é que o app use escopos com o nível mais restrito de acesso aos dados do usuário. Métodos diferentes podem exigir escopos diferentes. Por exemplo, um método em uma API pode exigir pelo menos um escopo somente leitura, enquanto outros métodos podem exigir um escopo de leitura e gravação.

Por padrão, todos os escopos do OAuth 2.0 do Google para uma API são ativados no APIs Explorer. Para testar com um escopo específico:

  1. Na seção "Credenciais Google OAuth 2.0", clique em mostrar escopos.
  2. Verifique o escopo a ser usado ao invocar o método.
  3. Clique em Executar para executar a API usando apenas o escopo selecionado. O APIs Explorer mostra uma tela de autorização pedindo que você conceda acesso para usar o escopo.
  4. Clique em Permitir. Os resultados aparecem abaixo do botão "Executar".

Se o APIs Explorer mostrar um resultado de 200 em um "application/json", o escopo será suficiente para invocar o método. Se o APIs Explorer mostrar um resultado 403, você escolheu um escopo insuficiente para invocar o método. Tente um escopo mais amplo.

Para mais informações sobre a seleção de escopo, consulte a seção de autenticação e autorização da documentação da sua API do Google específica.

Revogar o acesso autorizado para testar com novos escopos

Depois de usar a tela de autorização do Google para aprovar a autorização, a API Explorer permanece autorizada a fazer solicitações autenticadas enquanto as credenciais não expiram. Desmarcar escopos não redefine as credenciais e os escopos aprovados anteriormente. Se você quiser testar com uma nova configuração de escopo, revogue as credenciais aprovadas anteriormente.

Para revogar as credenciais usadas pelo APIs Explorer:

  1. Navegue até Apps com acesso à sua conta.
  2. Em Apps de terceiros com acesso à conta, clique em APIs Explorer do Google.
  3. Clique em Remover acesso.
  4. (Opcional) Recarregue a página de documentação para redefinir o APIs Explorer.