Usar chaves de API com a API Geolocation

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 Geolocation, você precisa ter um projeto com uma conta de faturamento e ativar a API Geolocation. 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 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:

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. Você é financeiramente responsável pelas cobranças causadas pelo abuso de chaves de API irrestritas. Para mais informações, consulte Práticas recomendadas de segurança de APIs.

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 da 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. Escolha API Geolocation na lista suspensa Selecionar APIs. Se a API Geolocation não estiver disponível, você vai precisar 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 services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Defina novas restrições para as chaves atuais. 

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

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

Adicionar a chave de API à solicitação

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

https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY

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