Criar chaves reCAPTCHA para apps para dispositivos móveis

Nesta página, explicamos como criar chaves reCAPTCHA (também conhecidas como chaves) para verificar as interações do usuário em apps para dispositivos móveis.

As chaves reCAPTCHA representam como o reCAPTCHA Enterprise é configurado para um aplicativo para dispositivos móveis (app).

Antes de começar

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

Criar uma chave reCAPTCHA

Só é possível criar chaves baseadas em pontuação para aplicativos móveis.

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

Crie uma chave reCAPTCHA para cada aplicativo para dispositivos móveis.
No Android, crie chaves separadas para estes cenários:
- O pacote do Android só está disponível na Google Play Store.
- O pacote do Android só está disponível em app stores fora da Google Play Store.
Crie chaves reCAPTCHA separadas para ambientes de preparo 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 é usando o console do Google Cloud. Como alternativa, é possível usar a API reCAPTCHA Enterprise ou a Google Cloud CLI.

Console

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

Acessar o reCAPTCHA Enterprise
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.
Clique em Criar chave.
No campo Nome de exibição, insira um nome de exibição para a chave.
Dependendo do tipo de chave reCAPTCHA que você quer criar para seu app para dispositivos móveis, faça a ação adequada:

Criar chaves reCAPTCHA para apps iOS

Recomendamos criar uma chave reCAPTCHA por aplicativo iOS.

No menu Escolher tipo de plataforma, selecione App iOS.

Na seção Lista de ID do pacote do iOS, clique em Adicionar ID do pacote do iOS.
No campo ID do pacote, insira o nome do ID do pacote do iOS.
Opcional: para adicionar outro ID do pacote, clique em Adicionar ID do pacote iOS e insira o nome no campo ID do pacote.
Opcional: defina as Configurações do desenvolvedor da Apple.

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

Digite as seguintes informações:
- Chave privada (.p8): gerada no Apple Centro para Desenvolvedores, em "Certificates, Identifiers & Profiles".
- Identificador de chave: é o identificador de chave de desenvolvedor da Apple (string de 10 caracteres).
- ID da equipe: o ID da equipe da Apple (string de 10 caracteres) que tem o perfil de provisionamento usado para criar o aplicativo.
Expanda Verificação verificação por documento de identidade e tipo de chave.
1. Para proteger a chave reCAPTCHA dos seus IDs de pacote, verifique se a opção Desativar verificação de ID do pacote está desativada.
2. Para o ambiente de não produção, se você quiser especificar uma pontuação que quer que a chave retorne quando qualquer avaliação for criada para ele, faça o seguinte:
  1. Clique no botão de alternância This is a Testing key.
  2. Na caixa Score, especifique uma pontuação entre 0 e 1,0.
Clique em Criar chave.

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

Criar chaves reCAPTCHA para apps Android

No menu Choose platform type, selecione Android app.
Na seção Lista de pacote do Android, clique em Adicionar pacote do Android.
No campo pacote do Android, insira o nome do pacote do Android.
(Opcional) Para incluir outro pacote, clique em Adicionar pacote do Android e digite o nome de outro pacote no campo Pacote do Android.
Expanda Verificação de nome de pacote, distribuição de apps e chaves de teste.

Para garantir que a chave reCAPTCHA seja usada apenas no seu app, desative a opção Desativar verificação do nome do pacote.
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.
Para o ambiente de não produção, se você quiser especificar uma pontuação que quer que a chave retorne quando qualquer avaliação for criada para ele, faça o seguinte:
1. Clique no botão de alternância This is a Testing key.
2. Na caixa Score, especifique uma pontuação entre 0 e 1,0.

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 recaptchakeys create.

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

DISPLAY_NAME: 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 comando gcloud recaptchakeys create:

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 recaptchakeys 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 Android de apps em que a chave pode ser usada. Para especificar vários nomes de pacotes, use um formato de lista separada por vírgulas.

Execute o comando gcloud recaptchakeys create:

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, faça as substituições a seguir:

DISPLAY_NAME: 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

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, 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 em que a chave pode ser usada. 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

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

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": {},
}

Criar chaves reCAPTCHA para apps para dispositivos móveis

Antes de começar

Criar uma chave reCAPTCHA

Console

Criar chaves reCAPTCHA para apps iOS

Criar chaves reCAPTCHA para apps Android

gcloud (iOS)

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

gcloud (Android)

Linux, macOS ou Cloud Shell

Windows (PowerShell)

Windows (cmd.exe)

REST (iOS)

curl

PowerShell

REST (Android)

curl

PowerShell

A seguir