Testar com diferentes tipos de credenciais e escopos

Na seção de credenciais do APIs Explorer, é possível testar com credenciais e escopos diferentes. Esse recurso é útil para garantir que você use as credenciais e o escopo mínimos necessários para invocar um endpoint da API.

Testar com credenciais diferentes

Por padrão, os tipos de credencial OAuth 2 e Chave de API são verificados. Se você quiser testar com apenas uma credencial, verifique o tipo de credencial a ser usado (e desmarque o outro tipo). Veja a seguir as regras gerais para escolher uma credencial para teste:

  • Se você estiver usando um método para acessar dados públicos, como dados do Google Maps, poderá usar uma chave de API como credencial. Marque a opção Chave de API e desmarque a opção Google OAuth 2.0.

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

Se você receber um resultado de 200, a credencial será suficiente para acessar os dados. Se você receber um resultado 401, precisará usar a credencial do OAuth 2 para acessar os dados.

Testar com escopos diferentes

Um escopo é uma string, como https://www.googleapis.com/auth/drive.metadata.readonly, que define um nível de acesso aos recursos exigidos pelo app, como o nível de acesso aos dados pertencentes aos usuários. O ideal é que seu 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/gravação.

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

  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 Execute para executar a API usando apenas o escopo selecionado. O APIs Explorer mostra uma tela de autorização solicitando o acesso para usar o escopo.
  4. Clique em Allow. 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 específica do Google.

Revogar o acesso autorizado para teste com novos escopos

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

Para revogar as credenciais usadas pelo APIs Explorer:

  1. Acesse 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) Atualize a página de documentação para redefinir o APIs Explorer.