Referensi JavaScript API untuk reCAPTCHA Enterprise

Halaman ini menjelaskan metode reCAPTCHA Enterprise JavaScript API dan parameter konfigurasinya yang dapat Anda gunakan untuk merender halaman web dengan kunci reCAPTCHA (kunci situs).

Metode reCAPTCHA Enterprise JavaScript API

Bagian ini menjelaskan sintaksis dan parameter metode JavaScript API reCAPTCHA Enterprise.

grecaptcha.enterprise.render

Merender container sebagai widget reCAPTCHA dan menampilkan ID widget yang baru dibuat.

Sintaksis

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

Parameter Metode

Parameter Deskripsi
container Elemen HTML untuk merender widget reCAPTCHA. Tentukan ID penampung (string) atau elemen DOM itu sendiri.
parameters

Objek yang berisi parameter sebagai key=value pair, misalnya, {"sitekey": "your_site_key", "action": "login", "theme": "dark"}.

Lihat Atribut dan parameter untuk mengetahui detail tentang setiap parameter yang dapat dikonfigurasi.

Nilai yang ditampilkan

Menampilkan ID widget yang baru dibuat.

grecaptcha.enterprise.reset

Mereset widget reCAPTCHA.

Sintaksis

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

Parameter

Parameter Deskripsi
widget_id Opsional. ID widget ditampilkan dari grecaptcha.enterprise.render(). Jika tidak ditentukan, ID secara default akan ditetapkan ke ID widget pertama yang dibuat.

Nilai yang ditampilkan

Tidak menampilkan nilai.

grecaptcha.enterprise.execute

Memanggil verifikasi reCAPTCHA Enterprise secara terprogram.

Sintaksis

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

Parameter

Parameter Deskripsi
widget_id Opsional. ID widget ditampilkan dari grecaptcha.enterprise.render().

Jika tidak ditentukan, ID secara default akan ditetapkan ke ID widget pertama yang dibuat.
sitekey

Menentukan kunci situs reCAPTCHA yang akan dilindungi.
action Objek dengan pasangan key=value tunggal, dengan nilai untuk kunci action menentukan nama tindakan yang terkait dengan elemen yang dilindungi.

Contoh: {"action": "action_name"}

Nilai yang ditampilkan

Jika berhasil, tampilkan objek Promise yang berisi token jika berhasil.

grecaptcha.enterprise.ready

Menjalankan fungsi Anda saat library JavaScript reCAPTCHA Enterprise dimuat.

Sintaksis

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

Parameter

Parameter Deskripsi
callback Fungsi yang akan dipanggil saat library reCAPTCHA selesai dimuat.

Nilai yang ditampilkan

Tidak menampilkan nilai.

grecaptcha.enterprise.getResponse

Mendapatkan respons untuk widget reCAPTCHA.

Sintaksis

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

Parameter

Parameter Deskripsi
widget_id Opsional. ID widget ditampilkan dari grecaptcha.enterprise.render(). Jika tidak ditentukan, ID secara default akan ditetapkan ke ID widget pertama yang dibuat.

Nilai yang ditampilkan

Mendapatkan respons widget reCAPTCHA. String ini bisa berupa string dengan token yang dibuat oleh grecaptcha.enterprise.execute(), atau string kosong jika token belum dibuat.

Konfigurasi

Bagian ini menjelaskan parameter resource JavaScript dan parameter yang digunakan oleh grecaptcha.enterprise.render() serta atribut widget g-recaptcha.

Parameter resource JavaScript (enterprise.js)

Tabel berikut mencantumkan parameter resource JavaScript (enterprise.js) yang harus Anda sertakan saat menggunakan reCAPTCHA Enterprise.

Untuk mengetahui informasi lebih lanjut tentang penggunaan parameter ini, lihat contoh di Merender widget reCAPTCHA di frontend.

Parameter Nilai Deskripsi
onload callback Opsional. Nama fungsi callback yang akan dieksekusi setelah semua dependensi dimuat.
render onload

Opsional, nilai default. Merender widget dalam tag g-recaptcha pertama yang ditemukannya.
explicit

Opsional. Tidak merender widget secara otomatis. Anda harus memanggil grecaptcha.enterprise.render() untuk merendernya secara terprogram.
siteKey

Jika digunakan dengan kunci situs berbasis skor, parameter ini tidak opsional. Nilai siteKey menentukan kunci situs berbasis skor yang terkait.
hl Lihat kode bahasa. Opsional. Memaksa widget untuk dirender dalam bahasa tertentu. Deteksi otomatis bahasa pengguna jika tidak ditentukan.

atribut tag g-recaptcha dan parameter grecaptcha.enterprise.render()

Tabel berikut mencantumkan atribut tag g-recaptcha dan parameter grecaptcha.enterprise.render() yang sesuai.

Atribut tag g-recaptcha Parameter grecaptcha.enterprise.render() Nilai yang diizinkan Default Deskripsi
data-sitekey sitekey Kunci reCAPTCHA.
data-badge badge bottomright, bottomleft, inline bottomright Opsional. Mengubah posisi badge reCAPTCHA. inline memungkinkan Anda memosisikannya dengan CSS.
data-action action Opsional. String yang menjelaskan tindakan saat ini.
data-theme theme dark, light light Opsional. Tema warna widget.
data-size size compact, normal normal Opsional. Ukuran widget.
data-tabindex tabindex Bilangan bulat 0 Opsional. Tabindex widget dan tantangan. Jika elemen lain di halaman Anda menggunakan tabindex, elemen tersebut harus disetel untuk mempermudah navigasi pengguna.
data-callback callback String T/A Opsional. Nama fungsi callback Anda, yang dijalankan saat pengguna berhasil mengirim respons. Token g-recaptcha-response diteruskan ke callback Anda.
data-expired-callback expired-callback String T/A Opsional. Nama fungsi callback Anda, yang dieksekusi ketika respons reCAPTCHA habis masa berlakunya dan pengguna harus melakukan verifikasi ulang.
data-error-callback error-callback String T/A Opsional. Nama fungsi callback Anda, yang dieksekusi ketika reCAPTCHA mengalami error (biasanya konektivitas jaringan) dan tidak dapat dilanjutkan hingga konektivitas pulih. Jika menentukan fungsi di sini, Anda bertanggung jawab untuk memberi tahu pengguna bahwa mereka harus mencoba lagi.