Especificación de la API CAPTCHA JavaScript

En esta sección se enumeran las especificaciones de los métodos y propiedades de las API de JavaScript CAPTCHA. Utilice las JavaScript API de CAPTCHA para ejecutar rompecabezas de CAPTCHA personalizados en sus aplicaciones cliente.

Esta API se basa en las API de amenazas inteligentes, que se utilizan para configurar y gestionar la adquisición y el uso de los AWS WAF tokens. Consulte Especificación de la API de amenazas inteligentes.

AwsWafCaptcha.renderCaptcha(container, configuration)

Presenta un rompecabezas de AWS WAF CAPTCHA al usuario final y, en caso de éxito, actualiza el token del cliente con la validación del CAPTCHA. Esto solo está disponible con la integración de CAPTCHA. Utilice esta llamada junto con las API de amenazas inteligentes para gestionar la recuperación de los tokens y proporcionarlos en sus llamadas fetch. Para usar las API de amenazas inteligentes en Especificación de la API de amenazas inteligentes.

A diferencia del intersticial de CAPTCHA que se AWS WAF envía, el rompecabezas de CAPTCHA renderizado con este método muestra el rompecabezas inmediatamente, sin una pantalla de título inicial.

container

El objeto Element para el elemento contenedor objetivo de la página. Por lo general, se recupera llamando a document.getElementById() o document.querySelector().

Obligatorio: sí

Tipo: Element

configuración

Un objeto que contiene los ajustes de configuración de CAPTCHA, de la siguiente manera:

apiKey

La clave de API cifrada que habilita los permisos para el dominio del cliente. Utilice la consola AWS WAF para generar las claves de API para los dominios de los clientes. Puede utilizar una clave para hasta cinco dominios. Para obtener más información, consulte Administración de claves de API para la API JS CAPTCHA.

Obligatorio: sí

Tipo: string

onSuccess: (wafToken: string) => void;

Se llama con un AWS WAF token válido cuando el usuario final completa correctamente un rompecabezas de CAPTCHA. Utilice el token en las solicitudes que envíe a los puntos finales que proteja con una AWS WAF ACL web. El token proporciona la prueba y la marca de tiempo de la última vez que se ha completado con éxito el rompecabezas.

Obligatorio: sí

onError?: (error: CaptchaError) => void;

Se llama con un objeto de error cuando se produce un error durante la operación de CAPTCHA.

Obligatorio: no

Definición de clase CaptchaError: el controlador onError proporciona un tipo de error con la siguiente definición de clase.

CaptchaError extends Error {
    kind: "internal_error" | "network_error" | "token_error" | "client_error";
    statusCode?: number;
}

• kind: el tipo de error devuelto.

• statusCode: el código de estado HTTP, si está disponible. Lo utiliza network_error si el error se debe a un error HTTP.

onLoad?: () => void;

Se llama cuando se carga un nuevo rompecabezas de CAPTCHA.

Obligatorio: no

onPuzzleTimeout?: () => void;

Se llama cuando un rompecabezas de CAPTCHA no se completa antes de que caduque.

Obligatorio: no

onPuzzleCorrect?: () => void;

Se llama cuando se proporciona una respuesta correcta a un rompecabezas de CAPTCHA.

Obligatorio: no

onPuzzleIncorrect?: () => void;

Se llama cuando se proporciona una respuesta incorrecta a un rompecabezas de CAPTCHA.

Obligatorio: no

defaultLocale

La configuración regional predeterminada que se utilizará en el rompecabezas de CAPTCHA. Las instrucciones escritas para los rompecabezas de CAPTCHA están disponibles en árabe (ar-SA), chino simplificado (zh-CN), holandés (nl-NL), inglés (en-US), francés (fr-FR), alemán (de-DE), italiano (it-IT), japonés (ja-JP), portugués brasileño (pt-BR), español (es-ES) y turco (tr-TR). Las instrucciones de audio están disponibles en todos los idiomas escritos, excepto en chino y japonés, que por defecto son el inglés. Para cambiar el idioma predeterminado, proporciona el idioma internacional y el código de configuración regional, por ejemplo,ar-SA.

Predeterminado: el idioma que se utiliza actualmente en el navegador del usuario final

Obligatorio: no

Tipo: string

disableLanguageSelector

Si se establece en true, el rompecabezas de CAPTCHA oculta el selector de idioma.

Valor predeterminado: false

Obligatorio: no

Tipo: boolean

dynamicWidth

Si se establece en true, el rompecabezas de CAPTCHA cambia de ancho para que sea compatible con el ancho de la ventana del navegador.

Valor predeterminado: false

Obligatorio: no

Tipo: boolean

skipTitle

Si se establece en true, el rompecabezas de CAPTCHA no mostrará el título del rompecabezas Resuelva el rompecabezas.

Valor predeterminado: false

Obligatorio: no

Tipo: boolean