Usar chaves de API

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 Maps JavaScript, você precisa de um projeto com uma conta de faturamento, além da API Maps JavaScript 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 da 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 as solicitações da lista de sites que você informou, selecione Referenciadores HTTP (sites da Web) na lista de Restrições do aplicativo.
      2. Especifique um ou mais sites de referenciadores. Caracteres curinga são aceitos para autorizar todos os subdomínios (por exemplo, *.google.com aceita todos os sites que terminam em .google.com). Especifique https:// e http:// como estão. Use uma representação especial para outros tipos de protocolos de URL referenciador. Por exemplo, formate file:///path/to/ como __file_url__//path/to/*. Depois de ativar os referenciadores, monitore seu uso para garantir que eles atendam às suas expectativas. Os seguintes protocolos de referência são compatíveis: about://, app://, applewebdata://, asset://, chrome://, content://, file://, ftp://, ionic://, local://, ms-appx://, ms-appx-web://, ms-local-stream://, prism://, qrc://, res://, saphtmlp://.
    • Restrições de API:
      1. Clique em Restringir chave.
      2. Selecione API Maps JavaScript na lista suspensa Selecionar APIs. Se a API Maps JavaScript não aparecer, será necessário ativá-la.
      3. Caso seu projeto use a Biblioteca do Places, selecione também a API Places. Além disso, se ele usa outros serviços na API JavaScript (Directions Service, Distance Matrix Service, Elevation Service e/ou Geocoding Service), também será necessário ativar e selecionar a API correspondente nessa lista.
  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="maps-backend.googleapis.com"
    --allowed-referrers="referer

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 da API Maps JavaScript. No exemplo a seguir, substitua YOUR_API_KEY pela sua chave.

  <script async defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap"></script>

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