Memulai

Endpoint

Halaman ini diterjemahkan otomatis dari versi bahasa Mandarin dan mungkin mengandung kesalahan. Versi bahasa Mandarin menjadi acuan utama.

YesCaptcha API memiliki dua endpoint dengan antarmuka dan parameter yang sama persis. Pilih sesuai lokasi server Anda:

Endpoint	Alamat	Cocok untuk
Endpoint global	`https://api.yescaptcha.com`	Server di luar Tiongkok daratan
Endpoint Tiongkok	`https://cn.yescaptcha.com`	Server di Tiongkok daratan

URL metode = alamat endpoint + nama metode, misalnya untuk membuat tugas:

POSThttps://api.yescaptcha.com/createTaskEndpoint global

POSThttps://cn.yescaptcha.com/createTaskEndpoint Tiongkok

Aturan

Hanya gunakan HTTPS.
Semua metode kecuali /useragent menggunakan POST, dengan body berupa JSON dan header Content-Type: application/json. Ukuran body tidak boleh melebihi 6 MB.
Autentikasi menggunakan clientKey di body request; tidak perlu header lain.

Metode	Fungsi	Keterangan
createTask	Membuat tugas	Jenis sinkron langsung mengembalikan hasil
getTaskResult	Memeriksa hasil tugas	Untuk jenis asinkron, lakukan polling setiap 5 detik
getBalance	Memeriksa saldo	Tanpa pemotongan poin
getSoftID	Memeriksa ID developer	Untuk bagi hasil developer
report	Melaporkan hasil pengenalan	Jenis pengenalan gambar dapat mengajukan pengembalian poin setelah laporan
useragent	Mendapatkan User-Agent yang disarankan	`GET`, digunakan untuk hCaptcha

Jika tidak dapat terhubung ke API, lihat Masalah koneksi dan jaringan.