Neste tópico, descrevemos como criar uma chave de API para o SDK do Maps para Android, adicionar ao seu app e proteger o aplicativo restringindo a chave. Você precisa incluir uma chave de API em qualquer app que use o SDK.
Antes de começar
Se você quiser usar o SDK do Maps para Android, é necessário ter um projeto com uma conta de faturamento, além de estar com esse SDK 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
-
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"
Leia 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 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 mais informações sobre os certificados digitais, consulte o guia Assinar seu app.
Para mais informações sobre como conseguir a impressão digital do certificado, consulte Como autenticar seu cliente. Se você estiver usando a Assinatura de apps do Google Play, acesse a página de assinatura de apps no Play Console para registrar sua impressão digital do certificado.
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:
- Selecione Apps Android.
- Clique em + Adicionar nome do pacote e impressão digital.
- Insira o nome do pacote e a impressão digital do certificado SHA-1. 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:
- Clique em Restringir chave.
- Selecione SDK do Maps para Android na lista suspensa Selecionar APIs. Se o SDK do Maps para Android não aparecer na lista, você precisará ativá-lo.
- Para concluir as mudanças, 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="maps-android-backend.googleapis.com"
--allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"
Leia mais sobre o SDK do Google Cloud, a instalação do SDK do Cloud e os seguintes comandos: