JavaScript CAPTCHA-API-Spezifikation

In diesem Abschnitt werden die Spezifikationen für die Methoden und Eigenschaften der JavaScript CAPTCHA-APIs aufgeführt. Verwenden Sie die JavaScript CAPTCHA-APIs, um benutzerdefinierte CAPTCHA-Rätsel in Ihren Client-Anwendungen auszuführen.

Diese API baut auf den intelligenten Bedrohungs-APIs auf, mit denen Sie die Erfassung und Verwendung von AWS WAF Token konfigurieren und verwalten. SieheAPI-Spezifikation für intelligente Bedrohungen.

AwsWafCaptcha.renderCaptcha(container, configuration)

Präsentiert dem Endbenutzer ein AWS WAF CAPTCHA-Puzzle und aktualisiert bei Erfolg das Client-Token mit der CAPTCHA-Validierung. Dies ist nur mit der CAPTCHA-Integration verfügbar. Verwenden Sie diesen Aufruf zusammen mit den intelligenten Bedrohungs-APIs, um den Token-Abruf zu verwalten und das Token in Ihren Aufrufen bereitzustellen. fetch Die APIs für intelligente Bedrohungen finden Sie unterAPI-Spezifikation für intelligente Bedrohungen.

Im Gegensatz zum CAPTCHA-Interstitial, das AWS WAF gesendet wird, zeigt das mit dieser Methode gerenderte CAPTCHA-Puzzle das Rätsel sofort an, ohne dass ein anfänglicher Titelbildschirm angezeigt wird.

container

Das Element Objekt für das Zielcontainerelement auf der Seite. Dies wird üblicherweise durch Aufrufen von document.getElementById() oder abgerufendocument.querySelector().

Erforderlich: Ja

Typ: Element

Konfiguration

Ein Objekt, das CAPTCHA-Konfigurationseinstellungen wie folgt enthält:

apiKey

Der verschlüsselte API-Schlüssel, der Berechtigungen für die Domäne des Kunden aktiviert. Verwenden Sie die AWS WAF Konsole, um Ihre API-Schlüssel für Ihre Kundendomänen zu generieren. Sie können einen Schlüssel für bis zu fünf Domains verwenden. Weitere Informationen finden Sie unter Verwaltung von API-Schlüsseln für die JS-CAPTCHA-API.

Erforderlich: Ja

Typ: string

onSuccess: (wafToken: string) => void;

Wird mit einem gültigen AWS WAF Token aufgerufen, wenn der Endbenutzer ein CAPTCHA-Rätsel erfolgreich gelöst hat. Verwenden Sie das Token in den Anfragen, die Sie an die Endgeräte senden, die Sie mit einer AWS WAF Web-ACL schützen. Das Token liefert den Nachweis und den Zeitstempel für die letzte erfolgreiche Lösung des Rätsels.

Erforderlich: Ja

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

Wird mit einem Fehlerobjekt aufgerufen, wenn während der CAPTCHA-Operation ein Fehler auftritt.

Erforderlich: Nein

CaptchaErrorKlassendefinition — Der onError Handler liefert einen Fehlertyp mit der folgenden Klassendefinition.

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

• kind— Die Art des zurückgegebenen Fehlers.

• statusCode— Der HTTP-Statuscode, falls verfügbar. Dieser wird verwendet, network_error wenn der Fehler auf einen HTTP-Fehler zurückzuführen ist.

onLoad?: () => void;

Wird aufgerufen, wenn ein neues CAPTCHA-Rätsel geladen wird.

Erforderlich: Nein

onPuzzleTimeout?: () => void;

Wird aufgerufen, wenn ein CAPTCHA-Rätsel nicht gelöst wird, bevor es abläuft.

Erforderlich: Nein

onPuzzleCorrect?: () => void;

Wird aufgerufen, wenn eine richtige Antwort auf ein CAPTCHA-Rätsel gegeben wurde.

Erforderlich: Nein

onPuzzleIncorrect?: () => void;

Wird aufgerufen, wenn eine falsche Antwort auf ein CAPTCHA-Rätsel gegeben wird.

Erforderlich: Nein

defaultLocale

Das Standard-Gebietsschema, das für das CAPTCHA-Rätsel verwendet werden soll. Die schriftlichen Anweisungen für CAPTCHA-Rätsel sind in Arabisch (ar-SA), vereinfachtem Chinesisch (zh-CN), Niederländisch (nl-NL), Englisch (en-US), Französisch (fr-FR), Deutsch (de-DE), Italienisch (it-IT), Japanisch (ja-JP), Portugiesisch (pt-BR), Spanisch (es-ES) und Türkisch (tr-TR) verfügbar. Audioanweisungen sind für alle Schriftsprachen verfügbar, mit Ausnahme von Chinesisch und Japanisch, für die standardmäßig Englisch verwendet wird. Um die Standardsprache zu ändern, geben Sie die internationale Sprache und den Ländercode an, ar-SA z. B.

Standard: Die Sprache, die derzeit im Browser des Endbenutzers verwendet wird

Erforderlich: Nein

Typ: string

disableLanguageSelector

Wenn auf gesetzttrue, verbirgt das CAPTCHA-Puzzle die Sprachauswahl.

Standard: false

Erforderlich: Nein

Typ: boolean

dynamicWidth

Wenn auf gesetzttrue, ändert das CAPTCHA-Puzzle aus Gründen der Kompatibilität mit der Breite des Browserfensters seine Breite.

Standard: false

Erforderlich: Nein

Typ: boolean

skipTitle

Wenn diese Option auf gesetzt isttrue, zeigt das CAPTCHA-Puzzle nicht die Überschrift Löse das Rätsel an.

Standard: false

Erforderlich: Nein

Typ: boolean