Como usar chaves de API

Selecione a plataforma: Android iOS JavaScript Web Service

Antes de começar

Antes de começar a usar o SDK do Places para Android, você precisa de um projeto com uma conta de faturamento e o SDK do Places para Android ativado. 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 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.

Ao restringir a chave de API, é necessário fornecer a impressão digital do certificado SHA-1 da chave usada para assinar o app. Há dois tipos de certificado:

  • Certificado de depuração: use esse tipo apenas com apps em teste e outros códigos que não sejam de produção. Não tente publicar um app assinado com um certificado de depuração. As ferramentas do SDK do Android geram esse certificado automaticamente quando você executa uma versão de depuração.
  • Certificado de lançamento: use esse tipo quando tudo estiver pronto para lançar seu aplicativo em uma app store. As Ferramentas do SDK do Android geram esse certificado quando você executa um build de lançamento.

Para saber mais informações sobre assinatura e certificados de app Android, consulte o guia Assinar seu app.

Para instruções sobre como encontrar a impressão digital do certificado de assinatura, consulte as referências abaixo:

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. Selecione Apps Android.
      2. Clique em + Adicionar nome do pacote e impressão digital.
      3. Insira o nome do pacote e a impressão digital do certificado SHA-1. Por exemplo: 
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • Restrições de API:
      1. Clique em Restringir chave.
      2. Selecione API Places ou API Places (nova). no menu suspenso Selecionar APIs, mas não ambas. Se a API Places não estiver na lista, você vai precisar ativá-la.
  4. Para concluir as mudanças, clique em Salvar.

SDK do Cloud

SDK do Places para Android (novo)

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

SDK do Places para Android

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-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Próxima etapa

Agora que você tem uma chave de API, crie e configure um projeto seguindo as instruções em Configurar um projeto do Android Studio.