Specifiche dell'API CAPTCHA JavaScript

Questa sezione elenca le specifiche per i metodi e le proprietà delle API CAPTCHA JavaScript . Usa le JavaScript API CAPTCHA per eseguire puzzle CAPTCHA personalizzati nelle tue applicazioni client.

Questa API si basa sulle API intelligenti per le minacce, che utilizzi per configurare e gestire l'acquisizione e l'utilizzo dei token. AWS WAF VediSpecifiche dell'API per le minacce intelligenti.

AwsWafCaptcha.renderCaptcha(container, configuration)

Presenta un puzzle AWS WAF CAPTCHA all'utente finale e, in caso di successo, aggiorna il token client con la convalida CAPTCHA. Questo è disponibile solo con l'integrazione CAPTCHA. Utilizza questa chiamata insieme alle API intelligenti per le minacce per gestire il recupero dei token e fornire il token nelle chiamate. fetch Consulta le API per le minacce intelligenti all'indirizzo. Specifiche dell'API per le minacce intelligenti

A differenza del CAPTCHA interstitial che AWS WAF invia, il puzzle CAPTCHA reso con questo metodo visualizza il puzzle immediatamente, senza una schermata iniziale del titolo.

container

L'Elementoggetto per l'elemento contenitore di destinazione sulla pagina. Questo viene in genere recuperato chiamando document.getElementById() odocument.querySelector().

Campo obbligatorio: sì

Tipo: Element

configurazione

Un oggetto contenente le impostazioni di configurazione CAPTCHA, come segue:

apiKey

La chiave API crittografata che abilita le autorizzazioni per il dominio del client. Usa la AWS WAF console per generare le tue chiavi API per i domini dei tuoi clienti. Puoi utilizzare una chiave per un massimo di cinque domini. Per informazioni, consulta Gestione delle API chiavi per JS CAPTCHA API.

Campo obbligatorio: sì

Tipo: string

onSuccess: (wafToken: string) => void;

Chiamato con un AWS WAF token valido quando l'utente finale completa con successo un puzzle CAPTCHA. Usa il token nelle richieste che invii agli endpoint che proteggi con un ACL web. AWS WAF Il token fornisce la prova e il timestamp dell'ultimo completamento riuscito del puzzle.

Campo obbligatorio: sì

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

Chiamato con un oggetto error quando si verifica un errore durante l'operazione CAPTCHA.

Campo obbligatorio: no

CaptchaErrordefinizione della classe — Il onError gestore fornisce un tipo di errore con la seguente definizione di classe.

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

• kind— Il tipo di errore restituito.

• statusCode— Il codice di stato HTTP, se disponibile. Viene utilizzato da network_error se l'errore è dovuto a un errore HTTP.

onLoad?: () => void;

Chiamato quando viene caricato un nuovo puzzle CAPTCHA.

Campo obbligatorio: no

onPuzzleTimeout?: () => void;

Chiamato quando un puzzle CAPTCHA non viene completato prima della scadenza.

Campo obbligatorio: no

onPuzzleCorrect?: () => void;

Chiamato quando viene fornita una risposta corretta a un puzzle CAPTCHA.

Campo obbligatorio: no

onPuzzleIncorrect?: () => void;

Chiamato quando viene fornita una risposta errata a un puzzle CAPTCHA.

Campo obbligatorio: no

defaultLocale

La localizzazione predefinita da usare per il puzzle CAPTCHA. Le istruzioni scritte per i puzzle CAPTCHA sono disponibili in arabo (ar-SA), cinese semplificato (zh-CN), olandese (nl-NL), inglese (en-US), francese (fr-FR), tedesco (de-DE), italiano (it-IT), giapponese (ja-JP), portoghese brasiliano (pt-BR), spagnolo (es-ES) e turco (tr-TR). Le istruzioni audio sono disponibili per tutte le lingue scritte tranne il cinese e il giapponese, che per impostazione predefinita è l'inglese. Per cambiare la lingua predefinita, fornisci la lingua internazionale e il codice locale, ad esempioar-SA.

Predefinita: la lingua attualmente in uso nel browser dell'utente finale

Campo obbligatorio: no

Tipo: string

disableLanguageSelector

Se impostato sutrue, il puzzle CAPTCHA nasconde il selettore della lingua.

Impostazione predefinita: false

Campo obbligatorio: no

Tipo: boolean

dynamicWidth

Se impostato sutrue, il puzzle CAPTCHA cambia larghezza per compatibilità con la larghezza della finestra del browser.

Impostazione predefinita: false

Campo obbligatorio: no

Tipo: boolean

skipTitle

Se impostato sutrue, il puzzle CAPTCHA non visualizza il titolo del puzzle Risolvi il puzzle.

Impostazione predefinita: false

Campo obbligatorio: no

Tipo: boolean