Referensi JavaScript API untuk reCAPTCHA

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

Metode reCAPTCHA JavaScript API

Bagian ini menjelaskan sintaksis dan parameter metode reCAPTCHA JavaScript API.

grecaptcha.enterprise.render

Merender penampung sebagai widget reCAPTCHA dan menampilkan ID widget yang baru saja dibuat.

Sintaks

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 pasangan kunci=nilai, 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.

Sintaks

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

Parameter

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

Nilai yang ditampilkan

Tidak menampilkan nilai.

grecaptcha.enterprise.execute

Memanggil verifikasi reCAPTCHA secara terprogram.

Sintaks

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 yang ditampilkan dari grecaptcha.enterprise.render(). Jika tidak ditentukan, ID widget pertama yang dibuat akan digunakan sebagai default. Catatan: Untuk digunakan dengan kunci situs kotak centang.
sitekey	Tentukan kunci situs reCAPTCHA yang akan dilindungi. Catatan: Untuk digunakan dengan kunci situs berbasis skor.
action	Objek dengan satu pasangan kunci=nilai, dengan nilai untuk kunci action menentukan nama tindakan yang terkait dengan elemen yang dilindungi. Catatan: Untuk digunakan dengan kunci situs berbasis skor. 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 dimuat.

Sintaks

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.

Sintaks

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

Parameter

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

Nilai yang ditampilkan

Mendapatkan respons widget reCAPTCHA. Ini dapat 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() dan atribut widget g-recaptcha.

Parameter resource JavaScript (enterprise.js)

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

Untuk informasi selengkapnya tentang cara menggunakan parameter ini, lihat contoh di Merender widget reCAPTCHA di frontend.

Parameter	Nilai	Deskripsi
onload	callback	Opsional. Nama fungsi callback Anda yang akan dieksekusi setelah semua dependensi dimuat.
render	onload	Nilai default opsional. Merender widget dalam tag g-recaptcha pertama yang ditemukannya. Catatan: Untuk digunakan dengan kunci situs kotak centang.
	explicit	Opsional. Tidak merender widget secara otomatis. Anda harus memanggil grecaptcha.enterprise.render() untuk merendernya secara terprogram. Catatan: Untuk digunakan dengan kunci situs kotak centang.
	siteKey	Jika digunakan dengan kunci situs berbasis skor, parameter ini tidak bersifat opsional. Nilai siteKey menentukan kunci situs berbasis skor yang terkait. Catatan: Hanya untuk digunakan dengan kunci situs berbasis skor; jika digunakan dengan kunci situs kotak centang, skrip tidak akan dimuat.
hl	Lihat kode bahasa.	Opsional. Memaksa widget dirender dalam bahasa tertentu. Mendeteksi bahasa pengguna secara otomatis 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. Posisikan ulang badge reCAPTCHA. inline memungkinkan Anda memosisikan 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 ditetapkan untuk memudahkan navigasi pengguna.
data-callback	callback	String	T/A	Opsional. Nama fungsi callback Anda, yang dijalankan saat pengguna mengirimkan respons yang berhasil. Token g-recaptcha-response diteruskan ke callback Anda.
data-expired-callback	expired-callback	String	T/A	Opsional. Nama fungsi callback Anda, yang dieksekusi saat masa berlaku respons reCAPTCHA berakhir dan pengguna perlu memverifikasi ulang.
data-error-callback	error-callback	String	T/A	Opsional. Nama fungsi callback Anda, yang dieksekusi saat reCAPTCHA mengalami error (biasanya konektivitas jaringan) dan tidak dapat dilanjutkan hingga konektivitas dipulihkan. Callback tidak menerima argumen apa pun yang berisi detail error. Jika menentukan fungsi di sini, Anda bertanggung jawab untuk memberi tahu pengguna bahwa mereka harus mencoba lagi.