Esta página explica como criar chaves reCAPTCHA (também conhecidas como chaves) para verificar as interações dos usuários nas páginas da Web.
As chaves reCAPTCHA representam como o reCAPTCHA está configurado para um site. A configuração inclui opções importantes, como a exibição de testes de CAPTCHA.
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
). - Escolha o tipo de chave mais adequado ao seu caso de uso.
Criar uma chave reCAPTCHA
Não há limite no número de chaves reCAPTCHA que podem ser criadas para um projeto Google Cloud . É melhor criar uma chave reCAPTCHA por site.
Recomendamos criar chaves separadas do reCAPTCHA 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 seu ambiente de teste.
A maneira mais simples de criar uma chave do reCAPTCHA é pelo Admin Console do reCAPTCHA. Como alternativa, use o console Google Cloud , a API reCAPTCHA Enterprise ou a Google Cloud CLI.
Admin Console
Acesse o Admin Console do reCAPTCHA.
- No campo Rótulo, insira um nome que possa ser usado para identificar seu site.
- Se quiser criar uma chave baseada em pontuação, selecione Com base em pontuação (v3). Se quiser criar uma chave de caixa de seleção, selecione Desafio (v2).
- Para adicionar um domínio, digite o nome dele e clique em
Para adicionar outro domínio, repita essa etapa. É possível adicionar até 250 domínios.
.
- Se você não conhece o console Google Cloud , leia os Termos de Serviço e marque a caixa de seleção.
- Clique em Enviar.
Se você não conhece o Google Cloud console, um projeto Google Cloud será criado e as APIs necessárias serão ativadas para você começar. Se você já tem um projeto do Google Cloud , as APIs necessárias estão ativadas para que você possa começar.
Console do Cloud
No console Google Cloud , acesse a página reCAPTCHA.
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.
- Em Tipo de aplicativo, selecione Web.
A seção Lista de domínios é exibida.
-
Insira o nome do domínio do seu site:
- Na seção Lista de domínios, clique em Adicionar um domínio.
- No campo Domínio, digite o nome do seu domínio.
Opcional: para adicionar outro domínio, clique em Adicionar um domínio e digite o nome de outro domínio no campo Domínio. É possível adicionar até 250 domínios.
Para sites, a chave reCAPTCHA é exclusiva para os domínios e subdomínios especificados. É possível especificar mais de um domínio caso seu site seja veiculado em vários. Se você especificar um domínio (por exemplo,
examplepetstore.com
), não precisará especificar os subdomínios (por exemplo,subdomain.examplepetstore.com
).Para usar uma chave em mais de 250 domínios, clique na chave Desativar verificação de domínio. O reCAPTCHA vai ignorar a lista de domínios. Você precisa fazer a verificação de domínio por conta própria examinando o campo
tokenProperties.hostname
nas avaliações que criar.
- Dependendo do tipo de chave reCAPTCHA que você quer criar para seu site, execute a ação adequada:
-
Para proteger a chave do reCAPTCHA para seu domínio e subdomínios,
verifique se a opção Desativar verificação de domínio
está desativada.
Desativar a verificação de domínio é um risco para a segurança porque não há restrições no site, então sua chave reCAPTCHA pode ser acessada e usada por qualquer pessoa.
- Se você quiser permitir que a chave baseada em pontuação funcione com Accelerated Mobile Pages (AMP), ative a opção Permitir que esta chave funcione com páginas AMP.
Para seu ambiente de não produção, se você quiser especificar uma pontuação que a chave retorne quando qualquer avaliação for criada para ela, faça o seguinte:
- Clique em Próxima etapa (opcional).
- Na etapa "Configurações adicionais", clique na opção Você está criando esta chave apenas para fins de teste?.
- Use o controle deslizante Definir pontuação para especificar uma pontuação entre 0 e 1,0.
- Clique em Criar chave.
-
Para proteger a chave do reCAPTCHA para seu domínio e subdomínios,
verifique se a opção Desativar verificação de domínio
está desativada.
Desativar a verificação de domínio é um risco para a segurança porque não há restrições no site, então sua chave reCAPTCHA pode ser acessada e usada por qualquer pessoa.
- Clique em Próxima etapa (opcional).
- Na etapa "Configurações adicionais", ative a opção Você vai usar desafios? alternar.
- Selecione a opção de Teste de segurança apropriada.
A opção de teste de segurança controla a probabilidade de um usuário receber um teste secundário, em que os usuários precisam selecionar imagens com base em uma categoria identificada. Por exemplo, selecionar as imagens com uma motocicleta ou escadas.
Se você quiser garantir a melhor proteção antifraude, selecione Difícil.
Se você selecionar Fácil, a probabilidade de receber o teste visual será menor.
-
Para seu ambiente de não produção, se você quiser especificar uma pontuação que a chave retorne quando qualquer avaliação for criada para ela, faça o seguinte:
- Clique na opção Você está criando esta chave apenas para fins de teste?.
- Use o controle deslizante Definir pontuação para especificar uma pontuação entre 0 e 1,0.
- Selecione a opção de Tipo de teste adequada.
- O Auto mostra o desafio às vezes.
- Sem CAPTCHA não mostra um desafio.
- Desafio sem solução mostra as imagens, mas o desafio não é concluído.
- Clique em Criar chave.
A chave recém-criada é listada na página Chaves reCAPTCHA.
Criar chaves reCAPTCHA baseadas em pontuação
A chave recém-criada é listada na página Chaves reCAPTCHA.
Criar chaves reCAPTCHA com caixa de seleção
gcloud
Para criar chaves do 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.
- INTEGRATION_TYPE: tipo de integração.
Dependendo do tipo de chaves, especifique os seguintes valores:
score
para chaves baseadas em pontuação.checkbox
para chaves de caixa de seleção.
- DOMAIN_NAME: domínios ou subdomínios de sites que podem usar
a chave.
Para especificar vários domínios, use um formato de lista separada por vírgulas.
Para usar uma chave em mais de 250 domínios, especifique
--allow-all-domains
para desativar a verificação de domínio. O reCAPTCHA vai ignorar a lista de domínios. Você precisa fazer a verificação de domínio por conta própria examinando o campotokenProperties.hostname
nas avaliações que criar.Desativar a verificação de domínio é um risco para a segurança porque não há restrições no site, então sua chave reCAPTCHA pode ser acessada e usada por qualquer pessoa.
Execute o comando gcloud recaptcha keys create:
Linux, macOS ou Cloud Shell
gcloud recaptcha keys create \ --web \ --display-name=DISPLAY_NAME \ --integration-type=INTEGRATION_TYPE \ --domains=DOMAIN_NAME
Windows (PowerShell)
gcloud recaptcha keys create ` --web ` --display-name=DISPLAY_NAME ` --integration-type=INTEGRATION_TYPE ` --domains=DOMAIN_NAME
Windows (cmd.exe)
gcloud recaptcha keys create ^ --web ^ --display-name=DISPLAY_NAME ^ --integration-type=INTEGRATION_TYPE ^ --domains=DOMAIN_NAME
A resposta contém a chave reCAPTCHA recém-criada.
REST
Para informações de referência da API sobre tipos de integração e chave, consulte Chave e Tipo de integração.Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- DISPLAY_NAME: nome da chave. Geralmente, um nome de site.
- INTEGRATION_TYPE: tipo de integração.
Dependendo do tipo de chaves, especifique os seguintes valores:
score
para chaves baseadas em pontuação.checkbox
para chaves de caixa de seleção.
- DOMAIN_NAME: domínios ou subdomínios de sites que podem usar
a chave.
Para especificar vários domínios, use um formato de lista separada por vírgulas.
Para usar uma chave em mais de 250 domínios, especifique
--allow-all-domains
para desativar a verificação de domínio. O reCAPTCHA vai ignorar a lista de domínios. Você precisa fazer a verificação de domínio por conta própria examinando o campotokenProperties.hostname
nas avaliações que criar.Desativar a verificação de domínio é um risco para a segurança porque não há restrições no site, então sua chave reCAPTCHA pode ser acessada e usada por qualquer pessoa.
Método HTTP e URL:
POST https://recaptchaenterprise.googleapis.com/v1/projects/PROJECT_ID/keys
Corpo JSON da solicitação:
{ "displayName": "DISPLAY_NAME", "webSettings": { "allowedDomains": "DOMAINS", "integrationType": "TYPE_OF_INTEGRATION" } }
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/6Ldqgs0UAAAAAIn4k7YxEB-LwEh5S9-Gv6IIWB8m", "displayName": "DISPLAY_NAME", "webSettings": { "allowAllDomains": false, "allowedDomains": [ DOMAINS ], "allowAmpTraffic": false, "integrationType": "SCORE", "challengeSecurityPreference": "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED" } }
(Opcional) Encontrar uma chave secreta legada do reCAPTCHA
Se você quiser fazer a integração com um aplicativo de terceiros que não usa a API reCAPTCHA Enterprise, será necessário ter a chave secreta legada.
Para cada chave do site criada, o reCAPTCHA cria uma chave secreta legada do reCAPTCHA (chave secreta legada), que pode ser usada com seu aplicativo de terceiros.
Se você precisar da chave secreta de uma chave do reCAPTCHA Clássico, migre a chave para o reCAPTCHA em Google Cloud e encontre a chave secreta legada.
Para encontrar a chave secreta legada, faça o seguinte:
No console Google Cloud , acesse a página reCAPTCHA.
Na seção Chaves reCAPTCHA, encontre a chave que você criou e clique nela.
Na página Detalhes da chave, na guia Integração, clique em Usar chave legada. Uma caixa de diálogo vai abrir com instruções sobre como usar a chave secreta legada.
A seguir
- Instale chaves baseadas em pontuação nas suas páginas da Web.
- Instale chaves de caixa de seleção nas suas páginas da Web.