Teste a próxima geração de recursos do Directions com a API Routes, agora disponível na visualização.

Usar chaves de API com a API Directions

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Para proteger os produtos da Plataforma Google Maps contra uso não autorizado, restrinja as chamadas de API às que fornecem credenciais de autenticação adequadas. Essas credenciais estão 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

Para usar a API Directions, é necessário um projeto com uma conta de faturamento, além de estar com a API Directions 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

  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 do Cloud

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

Saiba mais sobre o SDK do Google Cloud, a instalação do SDK do 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 pedidos não autorizados. 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 endereço IPv4 ou IPv6 ou uma sub-rede usando a notação CIDR (por exemplo, 192.168.0.0/22). Como a solicitação do serviço da Web verifica e compara o endereço IP externo com a restrição da chave de API, use o endereço IP público do servidor.
    • Restrições de API:
      1. Clique em Restringir chave.
      2. Escolha API Directions na lista suspensa Selecionar APIs. Se a API Directions não aparecer na lista, você precisará ativá-la.
  4. Para concluir as mudanças, clique em Salvar.

SDK do 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="directions-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

Saiba mais sobre o SDK do Google Cloud, a instalação do SDK do 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 Directions. No exemplo a seguir, substitua YOUR_API_KEY pela sua chave.

https://maps.googleapis.com/maps/api/directions/json?origin=Toronto&destination=Montreal&key=YOUR_API_KEY

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