Usar chaves de API com a API Places

Selecione a plataforma: Android iOS JavaScript Web Service

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.

Neste guia, mostramos 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 Places, você precisa de um projeto com uma conta de faturamento e as API Places ativada. Para saber mais, consulte Configurar no console do Cloud.

Criar chaves de API

Observação :se você estiver usando a API Places e a API Places atuais (Novo), recomendamos criar uma chave de API separada para cada versão de API. Para evitar cobranças acidentais, verifique todas as outras chaves de API para garantir que você tenha ativado apenas a API Places ou a API Places (nova) nessas chaves, quando necessário.

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 as solicitações da lista de endereços IP de servidores da Web que você fornecer, selecione Endereços IP (servidores da Web, cron jobs etc.) da lista de Restrições de aplicativos. Especifique um ou mais endereços IPv4 ou IPv6 ou sub-redes usando a notação CIDR. Os endereços IP devem corresponder ao endereço de origem 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 Places ou API Places (nova) na lista suspensa Selecionar APIs, mas não as duas. Se a API Places ou a API Places (nova) não estiver na lista, você vai precisar ativá-la.
   Observação: se você estiver usando a API Places atual e a API Places (nova), recomendamos que crie uma chave de API separada para cada versão.
4. Para concluir as mudanças, clique em Salvar.
   

SDK do Cloud

API Places (nova)

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="places.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

API Places

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="places-backend.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

É necessário incluir uma chave de API em todas as solicitações para a API Places. No exemplo a seguir, Substitua YOUR_API_KEY pela sua chave de API.

https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=YOUR_API_KEY

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

Observação: ao usar serviços da Web, todos os caracteres especiais nos parâmetros precisam ser codificados para uso em URL. Os URLs precisam ser devidamente codificados para serem válidos e são limitados a 2.048 caracteres para todos os serviços da Web. Esteja ciente desse limite ao criar seus URLs. Navegadores, proxies e os servidores também podem ter diferentes limites de caracteres de URL.