Autorizar solicitações

Quando seu aplicativo solicita dados privados, a solicitação precisa ser autorizada por um usuário autenticado com acesso a esses dados.

No caso dos dados públicos, a solicitação não precisa ser autorizada, mas precisa ser acompanhada por um identificador, como uma chave de API.

Cada solicitação que seu aplicativo envia à Resource Manager API precisa identificá-lo para o Google. Há duas maneiras de identificar o aplicativo: usando o token OAuth 2.0, que também autoriza a solicitação, e/ou usando a chave de API do aplicativo. Veja como determinar a melhor opção para você:

  • Se a solicitação exige autorização, como uma solicitação de dados particulares de um indivíduo, o aplicativo precisa fornecer um token OAuth 2.0 com a solicitação. Ele também pode fornecer a chave de API, mas isso não é obrigatório.
  • Se a solicitação não exige autorização, como uma solicitação de dados públicos, o aplicativo precisa fornecer a chave de API, um token OAuth 2.0 ou ambos, dependendo do que for mais conveniente para você.

Sobre protocolos de autorização

Seu aplicativo precisa usar o OAuth 2.0 para autorizar solicitações. Nenhum outro protocolo de autorização é aceito. Caso o aplicativo use o Login do Google, alguns aspectos da autorização serão tratados para você.

Como autorizar solicitações com OAuth 2.0

As solicitações para a Resource Manager API relacionadas a dados de usuário não públicos precisam ser autorizadas por um usuário autenticado.

Os detalhes do processo de autorização ou “fluxo” para o OAuth 2.0 variam um pouco, dependendo do tipo de aplicativo que você está criando. Este processo geral se aplica a todos os tipos de aplicativos:

  1. Ao criar o aplicativo, você faz o registro dele usando o Console do Google Cloud Platform. Em seguida, o Google fornece informações que serão necessárias mais tarde, como um ID e uma chave secreta do cliente.
  2. Ative a Resource Manager API no console do Google Cloud Platform. Se ela não estiver listada, ignore esta etapa.
  3. Quando seu aplicativo precisa de acesso aos dados do usuário, ele solicita ao Google um escopo específico de acesso.
  4. O Google exibe uma tela de consentimento para o usuário, pedindo para que o aplicativo seja autorizado a solicitar alguns dos dados dele.
  5. Se o usuário aprovar, o Google fornecerá ao aplicativo um token de acesso de curta duração.
  6. O aplicativo solicita dados de usuário, anexando o token de acesso à solicitação.
  7. Se o Google determinar que a solicitação e o token são válidos, ele retornará os dados solicitados.

Alguns fluxos incluem etapas adicionais, como atualizar tokens para adquirir novos tokens de acesso. Para mais informações sobre fluxos de vários tipos de aplicativos, acesse a documentação OAuth 2.0 do Google.

Veja as informações de escopo do OAuth 2.0 para a Resource Manager API:

Escopo Significado
https://www.googleapis.com/auth/cloud-platform Acesso de leitura e gravação.

Para solicitar acesso usando OAuth 2.0, o aplicativo precisa das informações do escopo, bem como das informações fornecidas pelo Google durante o registro do aplicativo, como o ID e a chave secreta do cliente.

Dica: as bibliotecas de cliente das APIs do Google podem lidar com alguns processos de autorização para você. Elas estão disponíveis para uma grande variedade de linguagens de programação. Verifique a página com bibliotecas e amostras para mais detalhes.

Como adquirir e usar uma chave de API

As solicitações de dados públicos à API Resource Manager precisam incluir um identificador, que pode ser uma chave de API ou um token de acesso.

Para adquirir uma chave de API:

  1. Abra a página de Credenciais no console do GCP.
  2. Essa API é compatível com dois tipos de credenciais. Crie as credenciais que forem adequadas ao seu projeto:
    • OAuth 2.0: quando o aplicativo solicita dados privados do usuário, ele precisa enviar um token OAuth 2.0 juntamente com a solicitação. O aplicativo primeiro envia um ID e, possivelmente, uma chave secreta do cliente para receber um token. É possível gerar credenciais OAuth 2.0 para aplicativos da Web, contas de serviço ou aplicativos instalados.

      Para mais informações, acesse a documentação do OAuth 2.0.

    • Chaves de API: uma solicitação que não fornece um token OAuth 2.0 precisa enviar uma chave de API. A chave identifica seu projeto e fornece acesso à API, à cota e aos relatórios.

      A API é compatível com diversos tipos de restrições em chaves de API. Se a chave de API de que você precisa ainda não existe, crie uma no Console clicando em Criar credenciais > Chave de API. É possível restringir a chave antes de usá-la na produção clicando em Restringir chave e selecionando uma das Restrições.

Para proteger as chaves de API, siga as práticas recomendadas para usar as chaves de API com segurança.

Depois que você está com uma chave de API, seu aplicativo pode adicionar o parâmetro da consulta key=yourAPIKey a todos os URLs das solicitações.

A chave de API é segura para ser incorporada a URLs sem precisar de codificação.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Documentação do Resource Manager