Referencia de la API de JavaScript para reCAPTCHA Enterprise

En esta página, se describen los métodos de la API de JavaScript de reCAPTCHA Enterprise y sus parámetros de configuración que puedes usar para renderizar las páginas web con una clave de reCAPTCHA (clave del sitio).

Métodos de la API de JavaScript reCAPTCHA Enterprise

En esta sección, se describe la sintaxis y los parámetros de los métodos de la API de JavaScript de reCAPTCHA Enterprise.

grecaptcha.enterprise.render

Renderiza el contenedor como un widget de reCAPTCHA y muestra el ID del widget recién creado.

Sintaxis

grecaptcha.enterprise.render(container: string | HTMLelement, parameters: Object): number

Parámetros de métodos

Parámetro	Descripción
container	El elemento HTML para renderizar el widget reCAPTCHA. Especifica el ID del contenedor (string) o el propio elemento del DOM.
parameters	Un objeto que contiene parámetros como pares clave=valor, por ejemplo, {"sitekey": "your_site_key", "action": "login", "theme": "dark"}. Consulta Atributos y parámetros para obtener detalles sobre cada parámetro configurable.

Valor de muestra

Muestra el ID del widget recién creado.

grecaptcha.enterprise.reset

Restablece el widget de reCAPTCHA.

Sintaxis

grecaptcha.enterprise.reset(widget_id: number): void

Parámetros

Parámetro	Descripción
widget_id	Opcional. ID de widget que muestra grecaptcha.enterprise.render(). Si no se especifica, se establece de forma predeterminada en el ID del primer widget que se creó.

Valor de muestra

No muestra un valor.

grecaptcha.enterprise.execute

Invoca la verificación de reCAPTCHA Enterprise de manera programática.

Sintaxis

grecaptcha.enterprise.execute(widget_id: number): Promise<string>

grecaptcha.enterprise.execute(sitekey: string, action: Object): Promise<string>

Parámetros

Parámetro	Descripción
widget_id	Opcional. ID de widget que muestra grecaptcha.enterprise.render(). Si no se especifica, se establece de forma predeterminada en el ID del primer widget que se creó. Nota: Se debe usar con claves de sitios con casillas de verificación.
sitekey	Especifica la clave del sitio de reCAPTCHA que se protegerá. Nota: Se usa con claves de sitios basadas en puntuaciones.
action	Un objeto con un solo par clave-valor, en el que el valor de la clave action especifica el nombre de la acción asociado con el elemento protegido. Nota: Se usa con claves de sitios basadas en puntuaciones. Por ejemplo: {"action": "action_name"}.

Valor de muestra

Si se ejecuta correctamente, muestra un objeto Promise que contiene el token.

grecaptcha.enterprise.ready

Ejecuta la función cuando se carga la biblioteca de JavaScript de reCAPTCHA Enterprise.

Sintaxis

grecaptcha.enterprise.ready(callback: function): void

Parámetros

Parámetro	Descripción
callback	La función a la que se debe llamar cuando la biblioteca de reCAPTCHA termina de cargarse.

Valor de muestra

No muestra un valor.

grecaptcha.enterprise.getResponse

Obtiene la respuesta para el widget de reCAPTCHA.

Sintaxis

grecaptcha.enterprise.getResponse(widget_id: number): string

Parámetros

Parámetro	Descripción
widget_id	Opcional. ID de widget que muestra grecaptcha.enterprise.render(). Si no se especifica, el valor predeterminado es el ID del primer widget que se creó.

Valor de muestra

Obtiene la respuesta del widget de reCAPTCHA. Puede ser una string con el token que creó grecaptcha.enterprise.execute() o una string vacía si aún no se creó el token.

Configuración

En esta sección, se describen los parámetros del recurso JavaScript y los parámetros que usa grecaptcha.enterprise.render(), así como los atributos del widget g-recaptcha.

Parámetros de recursos JavaScript (enterprise.js)

En la siguiente tabla, se enumeran los parámetros del recurso de JavaScript (enterprise.js) que debes incluir cuando usas reCAPTCHA Enterprise.

Para obtener más información sobre el uso de estos parámetros, consulta los ejemplos en Renderiza el widget de reCAPTCHA en el frontend.

Parámetro	Valor	Descripción
onload	callback	Opcional. Es el nombre de la función de devolución de llamada que se ejecutará después de que se carguen todas las dependencias.
render	onload	Valor predeterminado opcional. Renderiza el widget en la primera etiqueta g-recaptcha que encuentra. Nota: Se debe usar con claves de sitios con casillas de verificación.
	explicit	Opcional. No renderiza el widget automáticamente. Debes llamar a grecaptcha.enterprise.render() para procesarlo de manera programática. Nota: Se debe usar con claves de sitios con casillas de verificación.
	siteKey	Cuando se usa con claves de sitios basadas en puntuaciones, este parámetro no es opcional. El valor siteKey especifica la clave de sitio basada en puntuación asociada. Nota: Solo se debe utilizar con claves de sitios basadas en puntuaciones. Si se usa con claves de sitios con casillas de verificación, no se cargará la secuencia de comandos.
hl	Consulta códigos de lenguajes.	Opcional. Obliga al widget a renderizarse en un lenguaje específico. Detecta automáticamente el lenguaje del usuario si no se especifica.

Atributos de la etiqueta g-recaptcha y parámetros grecaptcha.enterprise.render()

En la siguiente tabla, se enumeran los atributos de la etiqueta g-recaptcha y los parámetros grecaptcha.enterprise.render() correspondientes.

Atributo de la etiqueta g-recaptcha	Parámetro grecaptcha.enterprise.render()	Valores permitidos	Predeterminada	Descripción
data-sitekey	sitekey			clave de reCAPTCHA.
data-badge	badge	bottomright, bottomleft, inline	bottomright	Opcional. Cambia la posición de la insignia de reCAPTCHA. inline te permite posicionarlo con CSS.
data-action	action			Opcional. Secuencia de comandos que describe la acción actual.
data-theme	theme	dark, light	light	Opcional. El tema de color del widget.
data-size	size	compact, normal	normal	Opcional. El tamaño del widget.
data-tabindex	tabindex	Integer	0	Opcional. El tabindex del widget y el desafío. Si otros elementos en tu página usan tabindex, debe configurarse para facilitar la navegación del usuario.
data-callback	callback	Cadena	No disponible	Opcional. El nombre de tu función de devolución de llamada, ejecutada cuando el usuario envía una respuesta exitosa. El token g-recaptcha-response se pasa a tu devolución de llamada.
data-expired-callback	expired-callback	Cadena	No disponible	Opcional. El nombre de tu función de devolución de llamada, ejecutada cuando la respuesta reCAPTCHA caduca y el usuario necesita volver a verificar.
data-error-callback	error-callback	Cadena	No disponible	Opcional. El nombre de tu función de devolución de llamada, ejecutada cuando reCAPTCHA encuentra un error (generalmente conectividad de red) y no puede continuar hasta que se restablezca la conectividad. Si especificas una función aquí, eres responsable de informar al usuario que debe volver a intentarlo.