Criar chaves reCAPTCHA para aplicativos para dispositivos móveis

Esta página explica como criar chaves reCAPTCHA (também conhecidas como chaves) para verificar as interações do usuário em seus aplicativos para dispositivos móveis.

As chaves reCAPTCHA representam como o reCAPTCHA está configurado para um aplicativo para dispositivos móveis.

Antes de começar

• Prepare seu ambiente para o reCAPTCHA.
• Verifique se você tem o seguinte papel do Identity and Access Management: administrador do reCAPTCHA Enterprise (roles/recaptchaenterprise.admin).

Criar uma chave reCAPTCHA

É possível criar apenas chaves baseadas em pontuação para aplicativos para dispositivos móveis.

Recomendamos o seguinte ao criar chaves reCAPTCHA para apps para dispositivos móveis:

• Crie uma chave reCAPTCHA para cada aplicativo para dispositivos móveis.

• Para Android, crie chaves separadas para os seguintes cenários:

  • O pacote do Android só está disponível na Google Play Store.
  • O pacote para Android só está disponível em app stores que não são da Google Play Store.

• Crie chaves reCAPTCHA separadas para ambientes de preparação e produção. Caso contrário, você corre o risco de poluir a análise de risco do reCAPTCHA com dados do ambiente de teste.

A maneira mais simples de criar uma chave reCAPTCHA é console do Google Cloud. Como alternativa, é possível usar a API reCAPTCHA Enterprise ou a CLI do Google Cloud.

Console

1. No console do Google Cloud, acesse a página reCAPTCHA.

   Acessar o reCAPTCHA

2. Verifique se o nome do projeto aparece no seletor de recursos, na parte superior da página.

   Se você não vir o nome do projeto, clique no seletor de recursos para selecioná-lo.

3. Clique em Criar chave.
4. No campo Nome de exibição, insira um nome de exibição para a chave.
5. Dependendo do tipo de chave reCAPTCHA que você quer criar para seu aplicativo para dispositivos móveis, faça a ação adequada:

Criar chaves reCAPTCHA para aplicativos iOS

Recomendamos criar uma chave reCAPTCHA por app iOS.

1. No menu Escolher o tipo de plataforma, selecione App iOS.
1. Na seção Lista de ID do pacote do iOS, clique em Adicionar ID do pacote do iOS.

2. No campo ID do pacote, insira o nome do ID do pacote do iOS.

3. Opcional: para adicionar outro ID do pacote, clique em Adicionar ID do pacote iOS. e insira o nome do ID do pacote iOS no campo ID do pacote.

4. Opcional: forneça as configurações do desenvolvedor da Apple.

   Recomendamos o envio desses dados porque eles permitem que o reCAPTCHA forneça pontuações de risco mais precisas para seu tráfego.

   Digite as seguintes informações:

   • Chave privada (.p8): é gerada no serviço da Centro para Desenvolvedores, em "Certificates, Identifiers &" Perfis.
   • Identificador de chave: é o identificador de chave do desenvolvedor da Apple (string de 10 caracteres).
   • ID da equipe: o ID da equipe da Apple (string de 10 caracteres) que possui o perfil de provisionamento usado para criar seu aplicativo.
5. Expanda Verificação de ID do pacote e tipo de chave.
   1. Para proteger a chave reCAPTCHA dos seus IDs de pacote, verifique se a opção Desativar verificação do ID do pacote está desativada.

   2. Para o ambiente que não é de produção, se você quiser especificar uma pontuação que a chave deve retornar quando as avaliações forem criadas, faça o seguinte:

      1. Clique no botão Esta é uma chave de teste.
      2. Na caixa Pontuação, especifique uma pontuação entre 0 e 1,0.
6. Clique em Criar chave.

A chave recém-criada é listada na página Chaves reCAPTCHA.

Criar chaves reCAPTCHA para aplicativos Android

1. No menu Escolher o tipo de plataforma, selecione App Android.
   
2. Na seção Lista de pacote do Android, clique em Adicionar pacote do Android.
3. No campo pacote do Android, insira o nome do pacote do Android.
4. (Opcional) Para incluir outro pacote, clique em Adicionar pacote do Android e digite o nome de outro pacote no campo Pacote do Android.
5. Expanda Verificação do nome do pacote, distribuição de apps e chaves de teste.
1. Para garantir que a chave reCAPTCHA seja usada apenas no app, desative a opção Desativar verificação de nome de pacote.
2. Se você quiser criar uma chave para um aplicativo disponível em outras app stores, além da Google Play Store, ative a opção Suporte a aplicativos distribuídos fora da Google Play Store.

3. Para o ambiente que não é de produção, se você quiser especificar uma pontuação que a chave deve retornar quando as avaliações forem criadas, faça o seguinte:

   1. Clique no botão Esta é uma chave de teste.
   2. Na caixa Pontuação, especifique uma pontuação entre 0 e 1,0.
6. Clique em Criar chave.

A chave recém-criada é listada na página Chaves reCAPTCHA.

gcloud (iOS)

Para criar chaves reCAPTCHA, use o comando gcloud recaptcha keys create.

Antes de usar os dados do comando abaixo, faça estas substituições:

• DISPLAY_NAME: o nome da chave. Geralmente, um nome de site.
• BUNDLE_IDs: os IDs do pacote de apps iOS autorizados a usar a chave. Para especificar vários IDs de pacote, use um formato de lista separada por vírgulas.

Execute o gcloud recaptcha keys create (link em inglês) comando:

Linux, macOS ou Cloud Shell

gcloud recaptcha keys create \
--display-name=DISPLAY_NAME  \
--ios --bundle-ids=BUNDLE_IDs

Windows (PowerShell)

gcloud recaptcha keys create `
--display-name=DISPLAY_NAME  `
--ios --bundle-ids=BUNDLE_IDs

Windows (cmd.exe)

gcloud recaptcha keys create ^
--display-name=DISPLAY_NAME  ^
--ios --bundle-ids=BUNDLE_IDs

A resposta contém a chave reCAPTCHA recém-criada.

gcloud (Android)

Para criar chaves reCAPTCHA, use o comando gcloud recaptcha keys create.

Antes de usar os dados do comando abaixo, faça estas substituições:

• DISPLAY_NAME: nome da chave. Geralmente, um nome de site.
• PACKAGE_NAMES: nomes de pacotes de apps Android autorizados a usar a chave. Para especificar vários nomes de pacotes, use um formato de lista separada por vírgulas.

Execute o gcloud recaptcha keys create (link em inglês) comando:

Linux, macOS ou Cloud Shell

gcloud recaptcha keys create \
--display-name=DISPLAY_NAME  \
--android --package-names=PACKAGE_NAMES

Windows (PowerShell)

gcloud recaptcha keys create `
--display-name=DISPLAY_NAME  `
--android --package-names=PACKAGE_NAMES

Windows (cmd.exe)

gcloud recaptcha keys create ^
--display-name=DISPLAY_NAME  ^
--android --package-names=PACKAGE_NAMES

A resposta contém a chave reCAPTCHA recém-criada.

REST (iOS)

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• DISPLAY_NAME: o nome da chave. Geralmente, o nome de um app.
• BUNDLE_IDs: os IDs do pacote de apps iOS autorizados a usar a chave. Para especificar vários IDs de pacote, use um formato de lista separada por vírgulas.

Método HTTP e URL:

POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

Corpo JSON da solicitação:

{
  "displayName": "DISPLAY_NAME",
  "iosSettings": {
   "allowedBundleIds":"BUNDLE_IDs"

  }
}

Para enviar a solicitação, escolha uma destas opções:

curl

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys"

PowerShell

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "name": "projects/project-id/keys/6LfhtywnAAAAABY3sCS2duZ6A55kmDXz-PNEgKgT",
  "displayName": "DISPLAY_NAME",
  "iosSettings": {
    "allowAllBundleIds": false,
    "allowedBundleIds": [
        BUNDLE_IDS
    ]
  },
  "labels": {},
}

REST (Android)

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

• DISPLAY_NAME: nome da chave. Geralmente, o nome de um app.
• PACKAGE_NAMES: nomes de pacotes Android de apps com permissão para use a chave. Para especificar vários nomes de pacotes, use um formato de lista separada por vírgulas.

Método HTTP e URL:

POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys

Corpo JSON da solicitação:

{
  "displayName": "DISPLAY_NAME",
  "androidSettings": {
  "allowedPackageNames":"PACKAGE_NAMES"
  }
}

Para enviar a solicitação, escolha uma destas opções:

curl

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que faz login automaticamente na CLI gcloud. . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys"

PowerShell

Observação: o comando a seguir pressupõe que você fez login na CLI gcloud com sua conta de usuário executando gcloud init ou gcloud auth login . É possível verificar a conta ativa atual executando gcloud auth list.

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys" | Select-Object -Expand Content

Você receberá uma resposta JSON semelhante a esta:

{
  "name": "projects/project-id/keys/6LcioSknAAAAABrjlMuZv2fjIGYMqwaAFC9izhoy",
  "displayName": "DISPLAY_NAME",
  "androidSettings": {
      "allowAllPackageNames": false,
      "allowedPackageNames": [
          PACKAGE_NAMES
      ],
      "supportNonGoogleAppStoreDistribution": false
  },
  "labels": {},
}

Observação: depois de criar chaves reCAPTCHA, você pode editá-las ou excluí-las. Não é possível recuperar chaves excluídas.

A seguir

• Instale chaves no iOS.
• Instale chaves no Android.