Como migrar do reCAPTCHA (versão não empresarial)

Neste documento, mostramos como migrar do reCAPTCHA (versão não Enterprise) para o reCAPTCHA Enterprise usando uma chave de site ativa. O processo de migração leva de cinco a dez minutos para ser concluído e não requer alterações no código.

Se você acessa o Admin Console do reCAPTCHA, então está usando a versão não Enterprise do reCAPTCHA, que tem funcionalidades restritas e limites rígidos para uso mensal. Para mais informações sobre a comparação de recursos, consulte Comparação de recursos entre versões do reCAPTCHA.

Após a migração, você se torna um usuário do reCAPTCHA Enterprise, e é cobrado quando excede 1.000.000 de solicitações por mês. Para mais informações, consulte os preços do reCAPTCHA Enterprise.

Antes de começar

  1. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  2. Verifique se o faturamento está ativado para seu projeto na nuvem. Saiba como confirmar se o faturamento está ativado para o projeto.

    O reCAPTCHA Enterprise exige que o faturamento seja vinculado e ativado no projeto para acessar a API. É possível ativar o faturamento usando um cartão de crédito ou um ID de projeto atual do Google Cloud. Se precisar de ajuda com o faturamento, entre em contato com o suporte do Cloud Billing.

  3. Se você quiser executar a ferramenta gcloud fora do Console do Google Cloud, instale e inicialize o SDK do Cloud. Para instruções, consulte: Instale e inicialize o SDK do Cloud..

Como ativar a API reCAPTCHA Enterprise

Console

  1. No Console do Cloud, acesse a página API reCAPTCHA Enterprise.

    Acessar a API reCAPTCHA Enterprise

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

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

  3. Clique em Enable.

gcloud

  1. Para definir o projeto do Google Cloud na sessão gcloud, execute o comando gcloud config set project. Substitua PROJECT_ID pelo ID do projeto do Google Cloud.
           gcloud config set project PROJECT_ID
           
  2. Para ativar a API reCAPTCHA Enterprise, execute o comando gcloud services enable:
             gcloud services enable recaptchaenterprise.googleapis.com
           
  3. Para verificar se a API reCAPTCHA Enterprise está ativada, execute o comando gcloud services list:
             gcloud services list --enabled
           

    Verifique se a API reCAPTCHA Enterprise está listada na lista de APIs ativadas.

Como migrar para o reCAPTCHA Enterprise

A migração de uma versão não Enterprise para o reCAPTCHA Enterprise envolve a escolha de uma chave de site ativa no Admin Console do reCAPTCHA e a migração da chave. É possível migrar uma ou mais chaves de site ativas. No entanto, só é possível migrar uma chave de site por vez.

Para executar o processo de migração, você precisa ter uma conta de usuário do reCAPTCHA que atenda aos seguintes requisitos:

  • No Admin Console do reCAPTCHA, a conta de usuário é listada como proprietária da chave de site que você quer migrar.
  • A conta de usuário tem um dos seguintes papéis do IAM para o projeto do Google Cloud para que a API reCAPTCHA Enterprise está ativada:
    • Proprietário do projeto (roles/owner)
    • Editor do projeto (roles/editor)
    • Administrador do reCAPTCHA Enterprise (roles/recaptchaenterprise.admin)
    Se a conta de usuário não tiver um desses papéis, peça ao administrador para conceder o papel ou siga as instruções em Como conceder, alterar e revogar acesso.
  1. Migre a chave de site usando o Cloud Shell, a ferramenta de linha de comando gcloud ou a API reCAPTCHA Enterprise:

    Cloud Shell

    1. No Console do Cloud, acesse Cloud Shell.
      Acesse o Cloud Shell
    2. Se for solicitado, clique em Autorizar.
    3. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .
      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

    4. Migre a chave do site.

      Execute o comando gcloud recaptcha keys migrate conforme mostrado no exemplo a seguir:

       gcloud recaptcha keys migrate SITE_KEY --project PROJECT-ID
      

      Forneça os valores a seguir:

      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.
      • PROJECT-ID: o ID do projeto do Google Cloud em que a API reCAPTCHA Enterprise está ativada.

    Ferramenta gcloud

    1. Para configurar a autenticação, execute o seguinte comando gcloud:

      gcloud auth login
      

      Faça login com a conta de usuário do reCAPTCHA que é proprietário da chave de site escolhida e que tenha um dos seguintes papéis: Proprietário do projeto, Editor do projeto ou Administrador do reCAPTCHA Enterprise.

    2. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .
      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

    3. Migre a chave do site.

      Execute o comando gcloud recaptcha keys migrate conforme mostrado no exemplo a seguir:

       gcloud recaptcha keys migrate SITE_KEY --project PROJECT-ID
      

      Forneça os valores a seguir:

      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.
      • PROJECT-ID: o ID do projeto do Google Cloud em que a API reCAPTCHA Enterprise está ativada.

    API REST

    1. Escolha e copie uma chave de site ativa que você usou para integrar o reCAPTCHA às suas páginas da Web:

      1. Acesse o Admin Console do reCAPTCHA e clique em .
      2. Escolha uma chave de site. As seguintes chaves de site reCAPTCHA são compatíveis com a migração: caixa de seleção reCAPTCHA v2, reCAPTCHA v2 invisível e reCAPTCHA v3.

      3. Para copiar a chave do site, clique em Copiar chave do site.

    2. Migre a chave do site.

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

      • PROJECT_ID: o ID do projeto do Google Cloud em que a API reCAPTCHA Enterprise está ativada.
      • SITE_KEY: a chave de site ativa que você copiou no Admin Console do reCAPTCHA.

      Método HTTP e URL:

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

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

      curl

      Execute o seguinte comando:

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

      PowerShell

      Execute o seguinte comando:

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

      Invoke-WebRequest `
      -Method POST `
      -Headers $headers `
      -Uri "https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys/SITE_KEY:migrate" | Select-Object -Expand Content

      Você receberá uma resposta JSON semelhante a esta:

      {
        "name": "projects/PROJECT-ID/keys/6Ldqgs0UAAAAAIn4k7YxEB-LwEh5S9-Gv6IIWB8m",
        "displayName": "My site key",
        "webSettings": {
          "allowAllDomains": false,
          "allowedDomains": [
            recaptcha.net
          ],
          "allowAmpTraffic": false,
          "integrationType": "SCORE",
          "challengeSecurityPreference": "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED"
        }
      }
      

  2. Para verificar se a chave de site foi migrada, faça o seguinte:

    Cloud Shell

    Execute o comando gcloud recaptcha keys list e encontre a chave de site migrada na lista.

    Ferramenta gcloud

    Execute o comando gcloud recaptcha keys list e encontre a chave de site migrada na lista.

    Console

    Acesse a página do reCAPTCHA Enterprise e encontre a chave de site migrada na lista.

    Acessar o reCAPTCHA Enterprise

Depois de migrar para o reCAPTCHA Enterprise, é possível continuar usando o método siteverify para avaliar o token de resposta reCAPTCHA de um usuário.

É possível revogar o papel do IAM de Administrador do reCAPTCHA Enterprise (roles/recaptchaenterprise.admin) na conta de usuário do reCAPTCHA. Peça para o administrador revogar o acesso ou siga as instruções sobre Como conceder, alterar e revogar acesso.

A seguir