Nesta página, descrevemos os métodos da API reCAPTCHA JavaScript e os parâmetros de configuração que podem ser usados para renderizar as páginas da Web com uma chave reCAPTCHA (chave do site).
Métodos da API reCAPTCHA JavaScript
Esta seção descreve a sintaxe e os parâmetros dos métodos da API reCAPTCHA JavaScript.
grecaptcha.enterprise.render
Renderiza o contêiner como um widget reCAPTCHA e retorna o ID do widget recém-criado.
Sintaxe
grecaptcha.enterprise.render(container: string | HTMLelement, parameters: Object): number
Parâmetros do método
Parâmetro | Descrição |
---|---|
container | O elemento HTML para renderizar o widget reCAPTCHA. Especifique o ID do contêiner (string) ou o próprio elemento DOM. |
parameters |
Um objeto que contém parâmetros como pares de chave=valor, por exemplo, Consulte Atributos e parâmetros para detalhes sobre cada parâmetro configurável. |
Valor de retorno
Retorna o ID do widget recém-criado.
grecaptcha.enterprise.reset
Redefine o widget reCAPTCHA.
Sintaxe
grecaptcha.enterprise.reset(widget_id: number): void
Parâmetros
Parâmetro | Descrição |
---|---|
widget_id | Opcional. ID do widget retornado de grecaptcha.enterprise.render() . Se não
for especificado, o padrão será o ID do primeiro widget criado.
|
Valor de retorno
Não retorna um valor.
grecaptcha.enterprise.execute
Invoca programaticamente a verificação reCAPTCHA.
Sintaxe
grecaptcha.enterprise.execute(widget_id: number): Promise<string>
grecaptcha.enterprise.execute(sitekey: string, action: Object): Promise<string>
Parâmetros
Parâmetro | Descrição |
---|---|
widget_id | Opcional. ID do widget retornado de grecaptcha.enterprise.render() .
Se não for especificado, o padrão será o ID do primeiro widget criado. |
sitekey |
Especifique a chave do site reCAPTCHA a ser protegida. |
action | Um objeto com um único par de chave-valor, em que o valor da chave action especifica o nome da ação associada ao elemento protegido.
Por exemplo: |
Valor de retorno
Se bem-sucedido, retorna um objeto de promessa contendo o token.
grecaptcha.enterprise.ready
Executa a função quando a biblioteca JavaScript reCAPTCHA é carregada.
Sintaxe
grecaptcha.enterprise.ready(callback: function): void
Parâmetros
Parâmetro | Descrição |
---|---|
callback | A função a ser chamada quando a biblioteca reCAPTCHA termina de carregar. |
Valor de retorno
Não retorna um valor.
grecaptcha.enterprise.getResponse
Obtém a resposta para o widget reCAPTCHA.
Sintaxe
grecaptcha.enterprise.getResponse(widget_id: number): string
Parâmetros
Parâmetro | Descrição |
---|---|
widget_id | Opcional. ID do widget retornado de grecaptcha.enterprise.render() . Se
não for especificado, o padrão será o ID do primeiro widget criado.
|
Valor de retorno
Recebe a resposta do widget reCAPTCHA. Pode ser uma string com o token criado por grecaptcha.enterprise.execute()
ou uma string vazia se o token ainda não tiver sido criado.
Configuração
Esta seção descreve os parâmetros de recurso JavaScript e os parâmetros
usados pelo grecaptcha.enterprise.render()
, além dos atributos do
widget g-recaptcha
.
Parâmetros do recurso JavaScript (enterprise.js)
A tabela a seguir lista os parâmetros do recurso JavaScript (enterprise.js
) que você precisa incluir ao usar o reCAPTCHA.
Para mais informações sobre como usar esses parâmetros, consulte os exemplos em Renderizar o widget reCAPTCHA no front-end.
Parâmetro | Valor | Descrição |
---|---|---|
onload |
callback | Opcional. O nome da função de callback a ser executada depois que todas as dependências forem carregadas. |
render
|
onload |
Opcional, valor padrão. Renderiza o widget na primeira tag |
explicit
|
Opcional. Não renderiza o widget automaticamente. É necessário chamar |
|
siteKey |
Quando usado com chaves de site baseadas em pontuação, esse parâmetro não é opcional. O valor siteKey especifica a chave do site baseada em pontuação associada. |
|
hl |
Veja códigos de linguagem | Opcional. Força o widget a renderizar em um idioma específico. Detecta automaticamente o idioma do usuário se não for especificado. |
Atributos de tag g-recaptcha e parâmetros grecaptcha.enterprise.render()
A tabela a seguir lista os atributos da tag g-recaptcha
e os parâmetros
grecaptcha.enterprise.render()
correspondentes.
Atributo de tag g-recaptcha |
Parâmetro grecaptcha.enterprise.render() |
Valores permitidos | Padrão | Descrição |
---|---|---|---|---|
data-sitekey |
sitekey |
Chave reCAPTCHA. | ||
data-badge |
badge |
bottomright , bottomleft , inline
|
bottomright |
Opcional. Reposicione o selo reCAPTCHA. inline permite posicioná-lo com CSS. |
data-action |
action |
Opcional. String que descreve a ação atual. | ||
data-theme |
theme |
dark |
light |
Opcional. O tema de cores do widget. |
data-size |
size |
compact , normal |
normal |
Opcional. O tamanho do widget. |
data-tabindex |
tabindex |
Inteiro | 0 | Opcional. O índice de tabulação do widget e desafio. Se outros elementos da sua página usarem tabindex, ele deverá ser definido para facilitar a navegação do usuário. |
data-callback |
callback |
String | N/A | Opcional. O nome da sua função de callback, executada quando o usuário
envia uma resposta bem-sucedida. O token g-recaptcha-response
é passado para seu callback. |
data-expired-callback |
expired-callback |
String | N/A | Opcional. O nome da sua função de callback, executada quando a resposta reCAPTCHA expira e o usuário precisa verificar novamente. |
data-error-callback |
error-callback |
String | N/A | Opcional. O nome da sua função de callback, executada quando o reCAPTCHA encontra um erro (geralmente conectividade de rede) e não pode continuar até que a conectividade seja restaurada. O callback não recebe argumentos com detalhes do erro. Se especificar uma função aqui, você será responsável por informar ao usuário que ele precisa tentar novamente. |