Usar chaves de API com a API Solar

Para proteger os produtos da Plataforma Google Maps contra uso não autorizado, as chamadas de API ficam restritas àquelas com as credenciais de autenticação adequadas. Essas credenciais vêm na forma de uma chave de API, uma string alfanumérica exclusiva que associa a conta de faturamento do Google ao seu projeto e à API ou ao SDK específico.

Este guia mostra como criar, restringir e usar uma chave de API para a Plataforma Google Maps.

Antes de começar : para usar a API Solar, você precisa de um projeto com uma conta de faturamento e a API Solar ativada. Recomendamos ter vários proprietários de projetos e administradores de faturamento para que sempre haja alguém disponível com essas funções na sua equipe. Para saber mais, consulte Configurar no console do Cloud.

Criar chaves de API

A chave de API é um identificador exclusivo que autentica solicitações associadas ao seu projeto para fins de uso e faturamento. Você precisa ter pelo menos uma chave de API associada ao projeto.

Para criar uma chave de API, siga estas etapas:

Console

1. Acesse a página Plataforma Google Maps > Credenciais.

   Acessar a página "Credenciais"

2. Na página Credenciais, clique em Criar credenciais > Chave de API.
   A caixa de diálogo Chave de API criada exibirá sua chave recém-criada.
3. Clique em Fechar.
   A nova chave vai aparecer na página Credenciais, em Chaves de API.
   Lembre-se de restringir a chave de API antes de usar na produção.

SDK Cloud

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

• gcloud alpha services api-keys create

Restringir chaves de API

O Google recomenda que você restrinja as chaves de API limitando o uso somente às APIs necessárias para o aplicativo. Isso deixa o app mais seguro, protegendo contra solicitações não autorizadas. Para mais informações, consulte Práticas recomendadas de segurança de APIs.

Ao restringir uma chave de API no console do Cloud, as restrições do aplicativo substituem todas as APIs ativadas em Restrições da API. Siga as práticas recomendadas criando outra chave de API para cada app e plataforma em que o aplicativo estiver disponível.

Para restringir uma chave de API, faça o seguinte:

Console

1. Acesse a página Plataforma Google Maps > Credenciais.

   Acessar a página "Credenciais"

2. Selecione a chave de API em que você quer definir uma restrição. A página de propriedades será exibida.
3. Em Restrições de chave, defina as seguintes opções:
• Restrições do aplicativo:
1. Para aceitar solicitações da lista de endereços IP de servidores da Web que você fornece, selecione Endereços IP (servidores da Web, cron jobs etc.) na lista de Restrições do aplicativo. Especifique um ou mais endereços IPv4 ou IPv6, ou sub-redes usando a notação CIDR. Os endereços IP precisam corresponder ao endereço de origem que os servidores da Plataforma Google Maps observam. Se você usa a conversão de endereços de rede (NAT), esse endereço geralmente corresponde ao endereço IP público da sua máquina.
• Restrições de API:
1. Clique em Restringir chave.
2. Selecione API Solar no menu suspenso Selecionar APIs. Se a API Solar não estiver na lista, será necessário ativá-la.
4. Para concluir as mudanças, clique em Salvar.
   

SDK Cloud

Liste as chaves atuais.

gcloud services api-keys list --project="PROJECT"

Limpe as restrições atuais na chave.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Defina novas restrições para as chaves atuais.

gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=solar.googleapis.com
    --allowed-ips="IP_ADDRESS"

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

Adicionar a chave de API à solicitação

Você precisa incluir uma chave de API em todas as solicitações da API Solar. No exemplo a seguir, substitua YOUR_API_KEY pela sua chave de API.

https://solar.googleapis.com/v1/buildingInsights:findClosest?location.latitude=37.2746464&location.longitude=-121.7530949&key=YOUR_API_KEY

O HTTPS é obrigatório para solicitações que usam uma chave de API.

Observação:ao usar os serviços da Web, todos os caracteres especiais nos parâmetros precisam ser codificados para uso em URL. Os URLs precisam ser codificados corretamente para serem válidos e estão limitados a 2.048 caracteres para todos os serviços da Web. Tenha isso em mente ao criar seus URLs. Diferentes navegadores, proxies e servidores podem ter limites de caracteres de URL diferentes.