Quando a sua aplicação solicita dados privados, o pedido tem de ser autorizado por um utilizador autenticado que tenha acesso a esses dados.
Quando a sua aplicação pede dados públicos, o pedido não tem de ser autorizado, mas tem de ser acompanhado por um identificador, como uma chave da API.
Todos os pedidos que a sua aplicação envia para a API Resource Manager têm de identificar a sua aplicação junto da Google. Existem duas formas de identificar a sua aplicação: através de um token OAuth 2.0 (que também autoriza o pedido) e/ou através da chave de API da aplicação. Veja como determinar que opção usar:
- Se o pedido exigir autorização (como um pedido de dados privados de um indivíduo), a aplicação tem de fornecer um token OAuth 2.0 com o pedido. A aplicação também pode fornecer a chave da API, mas não tem de o fazer.
- Se o pedido não exigir autorização (como um pedido de dados públicos), a aplicação tem de fornecer a chave de API ou um token OAuth 2.0, ou ambos, consoante a opção mais conveniente para si.
Acerca dos protocolos de autorização
A sua aplicação tem de usar o OAuth 2.0 para autorizar pedidos. Não são suportados outros protocolos de autorização. Se a sua aplicação usar a funcionalidade Iniciar sessão com o Google, alguns aspetos da autorização são processados por si.
Autorizar pedidos com o OAuth 2.0
Os pedidos à API Resource Manager de dados de utilizadores não públicos têm de ser autorizados por um utilizador autenticado.
Os detalhes do processo de autorização, ou "fluxo", para o OAuth 2.0 variam ligeiramente consoante o tipo de aplicação que está a escrever. O seguinte processo geral aplica-se a todos os tipos de candidaturas:
- Quando cria a sua aplicação, regista-a através da Google Cloud consola. Em seguida, a Google fornece informações de que vai precisar mais tarde, como um ID de cliente e um segredo do cliente.
- Ative a API Resource Manager na Google Cloud consola. (Se a API não estiver listada na Google Cloud consola, ignore este passo.)
- Quando a sua aplicação precisa de acesso aos dados do utilizador, pede à Google um âmbito de acesso específico.
- A Google apresenta um ecrã de consentimento ao utilizador, pedindo-lhe que autorize a sua aplicação a pedir alguns dos respetivos dados.
- Se o utilizador aprovar, a Google dá à sua aplicação uma chave de acesso de curta duração.
- A sua aplicação pede dados do utilizador, anexando o token de acesso ao pedido.
- Se a Google determinar que o seu pedido e o token são válidos, devolve os dados pedidos.
Alguns fluxos incluem passos adicionais, como a utilização de tokens de atualização para adquirir novos tokens de acesso. Para obter informações detalhadas sobre fluxos para vários tipos de aplicações, consulte a documentação do OAuth 2.0 da Google.
Seguem-se as informações do âmbito do OAuth 2.0 para a API Resource Manager:
| Âmbito | Significado |
|---|---|
https://www.googleapis.com/auth/cloud-platform |
Acesso de leitura/escrita. |
Para pedir acesso através do OAuth 2.0, a sua aplicação precisa das informações de âmbito, bem como das informações que a Google fornece quando regista a sua aplicação (como o ID de cliente e o segredo do cliente).
Sugestão: as bibliotecas cliente de APIs Google podem processar parte do processo de autorização por si. Estão disponíveis para várias linguagens de programação. Consulte a página com bibliotecas e exemplos para mais detalhes.
Adquirir e usar uma chave da API
Os pedidos à API Resource Manager de dados públicos têm de ser acompanhados por um identificador, que pode ser uma chave da API ou um token de acesso.
Para adquirir uma chave da API:
- Abra a página Credenciais na Google Cloud consola.
-
Esta API suporta dois tipos de credenciais.
Crie as credenciais adequadas para o seu projeto:
-
OAuth 2.0: sempre que a sua aplicação solicitar dados privados do utilizador, tem de enviar um token do OAuth 2.0 juntamente com o pedido. A sua aplicação envia primeiro um ID de cliente e, possivelmente, um segredo do cliente para obter um token. Pode gerar credenciais do OAuth 2.0 para aplicações Web, contas de serviço ou aplicações instaladas.
Para mais informações, consulte a documentação do OAuth 2.0.
-
Chaves da API: Um pedido que não faculte um token do OAuth 2.0 tem de enviar uma chave da API. A chave identifica o seu projeto e fornece acesso à API, quota e relatórios.
A API suporta vários tipos de restrições nas chaves da API. Se a chave da API de que precisa ainda não existir, crie uma chave da API na consola clicando em Criar credenciais > Chave da API. Pode restringir a chave antes de a usar em produção clicando em Restringir chave e selecionando uma das Restrições.
-
Para manter as chaves da API seguras, siga as práticas recomendadas para usar chaves da API de forma segura.
Depois de ter uma chave de API, a sua aplicação pode anexar o parâmetro de consulta
key=yourAPIKey a todos os URLs de pedidos.
A chave da API é segura para incorporação em URLs e não requer codificação.