Spesifikasi CAPTCHA API JavaScript

Bagian ini mencantumkan spesifikasi untuk metode dan properti CAPTCHA API JavaScript . Gunakan CAPTCHA JavaScript API untuk menjalankan teka-teki CAPTCHA khusus di aplikasi klien Anda.

API ini dibangun di atas API ancaman cerdas, yang Anda gunakan untuk mengonfigurasi dan mengelola akuisisi dan penggunaan AWS WAF token. LihatSpesifikasi API ancaman cerdas.

AwsWafCaptcha.renderCaptcha(container, configuration)

Menyajikan teka-teki AWS WAF CAPTCHA kepada pengguna akhir dan, setelah berhasil, memperbarui token klien dengan validasi CAPTCHA. Ini hanya tersedia dengan integrasi CAPTCHA. Gunakan panggilan ini bersama dengan API ancaman cerdas untuk mengelola pengambilan token dan menyediakan token dalam fetch panggilan Anda. Lihat API ancaman cerdas diSpesifikasi API ancaman cerdas.

Berbeda dengan pengantara CAPTCHA yang AWS WAF mengirim, teka-teki CAPTCHA yang diberikan oleh metode ini menampilkan teka-teki segera, tanpa layar judul awal.

container

ElementObjek untuk elemen kontainer target pada halaman. Ini biasanya diambil dengan menelepon document.getElementById() ataudocument.querySelector().

Diperlukan: Ya

Tipe: Element

konfigurasi

Objek yang berisi pengaturan konfigurasi CAPTCHA, sebagai berikut:

apiKey

Kunci API terenkripsi yang memungkinkan izin untuk domain klien. Gunakan AWS WAF konsol untuk membuat kunci API Anda untuk domain klien Anda. Anda dapat menggunakan satu kunci hingga lima domain. Untuk informasi, lihat Mengelola API kunci untuk JS CAPTCHA API.

Diperlukan: Ya

Tipe: string

onSuccess: (wafToken: string) => void;

Dipanggil dengan AWS WAF token yang valid ketika pengguna akhir berhasil menyelesaikan teka-teki CAPTCHA. Gunakan token dalam permintaan yang Anda kirim ke titik akhir yang Anda lindungi dengan ACL AWS WAF web. Token memberikan bukti dan stempel waktu penyelesaian teka-teki terbaru yang berhasil.

Diperlukan: Ya

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

Dipanggil dengan objek kesalahan ketika terjadi kesalahan selama operasi CAPTCHA.

Diperlukan: Tidak

CaptchaErrordefinisi kelas - onError Handler menyediakan jenis kesalahan dengan definisi kelas berikut.

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

• kind— Jenis kesalahan yang dikembalikan.

• statusCode— Kode status HTTP, jika tersedia. Ini digunakan oleh network_error jika kesalahan disebabkan oleh kesalahan HTTP.

onLoad?: () => void;

Dipanggil ketika teka-teki CAPTCHA baru dimuat.

Diperlukan: Tidak

onPuzzleTimeout?: () => void;

Dipanggil ketika teka-teki CAPTCHA tidak selesai sebelum kedaluwarsa.

Diperlukan: Tidak

onPuzzleCorrect?: () => void;

Dipanggil ketika jawaban yang benar diberikan untuk teka-teki CAPTCHA.

Diperlukan: Tidak

onPuzzleIncorrect?: () => void;

Dipanggil ketika jawaban yang salah diberikan untuk teka-teki CAPTCHA.

Diperlukan: Tidak

defaultLocale

Lokal default yang digunakan untuk teka-teki CAPTCHA. Instruksi tertulis untuk teka-teki CAPTCHA tersedia dalam bahasa Arab (ar-sa), bahasa Mandarin sederhana (Zh-CN), Belanda (nl-NL), Inggris (en-US), Prancis (fr-Fr), Jerman (de-DE), Italia (IT-it), Jepang (Ja-jp), Portugis Brasil (Pt-BR), Spanyol (es-ES), dan Turki (Tr-tr). Instruksi audio tersedia untuk semua bahasa tertulis kecuali bahasa Mandarin dan Jepang, yang default ke bahasa Inggris. Untuk mengubah bahasa default, berikan bahasa internasional dan kode lokal, misalnya,ar-SA.

Default: Bahasa yang saat ini digunakan di browser pengguna akhir

Diperlukan: Tidak

Tipe: string

disableLanguageSelector

Jika diatur ketrue, teka-teki CAPTCHA menyembunyikan pemilih bahasa.

Default: false

Diperlukan: Tidak

Tipe: boolean

dynamicWidth

Jika diatur ketrue, teka-teki CAPTCHA mengubah lebar untuk kompatibilitas dengan lebar jendela browser.

Default: false

Diperlukan: Tidak

Tipe: boolean

skipTitle

Jika diatur ketrue, teka-teki CAPTCHA tidak menampilkan judul puzzle Pecahkan teka-teki.

Default: false

Diperlukan: Tidak

Tipe: boolean