Crie chaves reCAPTCHA para aplicações para dispositivos móveis

Esta página explica como criar chaves do reCAPTCHA (também conhecidas como chaves) para validar as interações dos utilizadores nas suas aplicações para dispositivos móveis.

As chaves reCAPTCHA representam a forma como o reCAPTCHA está configurado para uma aplicação para dispositivos móveis (app).

Antes de começar

  • Prepare o seu ambiente para o reCAPTCHA.
  • Certifique-se de que tem a seguinte função de gestão de identidades e acessos: administrador do reCAPTCHA Enterprise (roles/recaptchaenterprise.admin).

Crie uma chave reCAPTCHA

Só pode criar chaves baseadas em pontuações para aplicações para dispositivos móveis.

Recomendamos o seguinte quando criar chaves do reCAPTCHA para aplicações para dispositivos móveis:

  • Crie uma chave do reCAPTCHA para cada aplicação para dispositivos móveis.
  • Para Android, crie chaves separadas para os seguintes cenários:

    • O pacote Android só está disponível na Google Play Store.
    • O pacote Android só está disponível em lojas de apps que não sejam a Google Play Store.
  • Crie chaves reCAPTCHA separadas para ambientes de teste e produção. Caso contrário, corre o risco de poluir a análise de risco do reCAPTCHA com dados do seu ambiente de teste.

A forma mais simples de criar uma chave do reCAPTCHA é através da Google Cloud consola. Em alternativa, pode usar a API reCAPTCHA Enterprise ou a CLI Google Cloud.

Consola

  1. Na Google Cloud consola, aceda à página reCAPTCHA.

    Aceder ao reCAPTCHA

  2. Verifique se o nome do seu projeto é apresentado no seletor de recursos na parte superior da página.

    Se não vir o nome do seu projeto, clique no seletor de recursos e, de seguida, selecione o seu projeto.

  3. Clique em Criar chave.
  4. No campo Nome a apresentar, introduza um nome a apresentar para a chave.
  5. Consoante o tipo de chave do reCAPTCHA que quer criar para a sua aplicação para dispositivos móveis, execute a ação adequada:
  6. Crie chaves reCAPTCHA para aplicações iOS

    Recomendamos que crie uma chave do reCAPTCHA por aplicação iOS.

    1. Para o Tipo de aplicação, selecione iOS.
      1. Na secção Lista de IDs de pacotes iOS, clique em Adicionar ID de pacote iOS.
      2. No campo ID do pacote, introduza o nome do ID do pacote do iOS.

      3. Opcional: para adicionar um ID do pacote adicional, clique em Adicionar ID do pacote iOS e introduza o nome do ID do pacote iOS no campo ID do pacote.
      4. Para proteger a chave do reCAPTCHA para os seus IDs de pacote, certifique-se de que o botão Desativar validação do ID de pacote está desativado.
      5. Opcional: faculte as definições de programador da Apple.

        Recomendamos que forneça estes dados, uma vez que permitem que o reCAPTCHA forneça pontuações de risco mais precisas para o seu tráfego.

        Introduza as seguintes informações:

        • Chave privada (.p8): esta é gerada no Apple Developer Center em Certificates, Identifiers & Profiles.
        • Identificador da chave: o identificador da chave de programador da Apple (string de 10 carateres).
        • ID da equipa: o ID da equipa da Apple (string de 10 carateres) proprietária do perfil de aprovisionamento usado para criar a sua aplicação.
      6. Opcional: clique em Passo seguinte (opcional).
        1. Para o seu ambiente de não produção, se quiser especificar uma pontuação que a chave devolva quando forem criadas avaliações para a mesma, faça o seguinte:

          1. Em Definições adicionais, clique no botão Está a criar esta chave apenas para fins de teste?.
          2. Use o controlo de deslize Definir pontuação para especificar uma pontuação entre 0 e 1,0.
      7. Clique em Criar chave.
      8. A chave criada recentemente é apresentada na página Chaves do reCAPTCHA.

    Crie chaves reCAPTCHA para aplicações Android

    1. Para o Tipo de aplicação, selecione Android.
    2. Na secção Lista de pacotes Android, clique em Adicionar pacote Android.
    3. No campo Pacote Android, introduza o nome do seu pacote Android.
    4. Opcional: para adicionar outro pacote, clique em Adicionar pacote Android e introduza o nome de outro pacote Android no campo Pacote Android.
    5. Para aplicar que a chave do reCAPTCHA seja usada apenas na sua app, desative o botão de ativação/desativação Desativar validação do nome do pacote.
    6. Se quiser criar uma chave para uma aplicação que esteja disponível noutras lojas de apps além da Google Play Store, ative a opção Suportar aplicações distribuídas fora da Google Play Store.
    7. Opcional: clique em Passo seguinte (opcional).
      1. Para o seu ambiente de não produção, se quiser especificar uma pontuação que a chave devolva quando forem criadas avaliações para a mesma, faça o seguinte:

        1. Em Definições adicionais, clique no botão Está a criar esta chave apenas para fins de teste?.
        2. Use o controlo de deslize Definir pontuação para especificar uma pontuação entre 0 e 1,0.
    8. Clique em Criar chave.
    9. A chave criada recentemente é apresentada na página Chaves do reCAPTCHA.

gcloud (iOS)

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

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

  • DISPLAY_NAME: nome da chave. Normalmente, um nome do site.
  • BUNDLE_IDs: IDs de pacotes iOS de apps autorizadas a usar a chave. Especifique vários IDs de pacote como uma lista separada por vírgulas.

Execute o comando gcloud recaptcha keys 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 do reCAPTCHA, use o comando gcloud recaptcha keys create.

Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:

  • DISPLAY_NAME: nome da chave. Normalmente, um nome do site.
  • PACKAGE_NAMES: nomes de pacotes Android de apps autorizadas a usar a chave. Especifique vários nomes de pacotes como uma lista separada por vírgulas.

Execute o comando gcloud recaptcha keys 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 qualquer um dos dados do pedido, faça as seguintes substituições:

  • DISPLAY_NAME: nome da chave. Normalmente, o nome de uma app.
  • BUNDLE_IDs: IDs de pacotes iOS de apps autorizadas a usar a chave. Especifique vários IDs de pacote como uma lista separada por vírgulas.

Método HTTP e URL:

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

Corpo JSON do pedido:

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

  }
}

Para enviar o seu pedido, escolha uma destas opções:

curl

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

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

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

$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

Deve receber uma resposta JSON semelhante à seguinte:


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

REST (Android)

Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:

  • DISPLAY_NAME: nome da chave. Normalmente, o nome de uma app.
  • PACKAGE_NAMES: nomes de pacotes Android de apps autorizadas a usar a chave. Especifique vários nomes de pacotes como uma lista separada por vírgulas.

Método HTTP e URL:

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

Corpo JSON do pedido:


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

Para enviar o seu pedido, escolha uma destas opções:

curl

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

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

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

$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

Deve receber uma resposta JSON semelhante à seguinte:


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

O que se segue?