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 sua chave de API para a Plataforma Google Maps.
Antes de começar
Antes de começar a usar a API Roads, você precisa ter um projeto com uma conta de faturamento e a API Roads ativada. 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
-
Acesse a página Plataforma Google Maps > Credenciais.
-
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. -
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:
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.
Para restringir uma chave de API, faça o seguinte:
Console
-
Acesse a página Plataforma Google Maps > Credenciais.
- Selecione a chave de API em que você quer definir uma restrição. A página de propriedades será exibida.
- Em Restrições de chave, defina as seguintes opções:
- Restrições do aplicativo:
- Para aceitar solicitações da lista de endereços IP do servidor da Web fornecidas por você, 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 uma sub-rede usando a notação CIDR. Os endereços IP precisam corresponder ao endereço de origem observado pelos servidores da Plataforma Google Maps. Se você usa a conversão de endereços de rede (NAT, na sigla em inglês), isso geralmente corresponde ao endereço IP público da sua máquina.
- Restrições de API:
- Clique em Restringir chave.
- Selecione API Roads na lista suspensa Selecionar APIs. Se a API Roads não estiver listada, será necessário ativá-la.
- Para concluir as alterações, 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/keys/KEY_ID" \
--api-target="roads.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
É necessário incluir uma chave de API em todas as solicitações da API Roads. No exemplo a seguir, substitua YOUR_API_KEY pela sua chave de API.
https://roads.googleapis.com/v1/snapToRoads?path=-35.27801,149.12958|-35.28032,149.12907|-35.28099,149.12929|-35.28144,149.12984|-35.28194,149.13003|-35.28282,149.12956|-35.28302,149.12881|-35.28473,149.12836
&interpolate=true
&key=YOUR_API_KEY
O HTTPS é obrigatório para solicitações que usam uma chave de API.