Lewati ke konten
StatusDasbor

Referensi API

createTask — membuat tugas

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

createTask membuat tugas pengenalan; task.type menentukan captcha mana yang akan diselesaikan. Jenis asinkron mengembalikan taskId, yang kemudian Anda gunakan di getTaskResult untuk mengambil hasil; jenis sinkron langsung mengembalikan hasilnya.

POSThttps://api.yescaptcha.com/createTaskEndpoint global
POSThttps://cn.yescaptcha.com/createTaskEndpoint Tiongkok
Field Tipe Wajib Keterangan
clientKey string Ya ClientKey akun Anda, salin dari dasbor yescaptcha.com
task object Ya Objek tugas. Harus memiliki type; field lainnya mengikuti jenis tugas (lihat halaman masing-masing jenis tugas)
softID integer Tidak ID developer. Sertakan ID Anda jika software buatan Anda dipakai orang lain agar mendapat bagi hasil; lihat Bagi hasil developer

Mengenali captcha gambar (sinkron):

{
"clientKey": "YOUR_CLIENT_KEY",
"task": {
"type": "ImageToTextTaskOcrBase",
"body": "BASE64_IMAGE"
}
}

Mendapatkan token reCAPTCHA v2 (asinkron):

{
"clientKey": "YOUR_CLIENT_KEY",
"task": {
"type": "NoCaptchaTaskProxyless",
"websiteURL": "https://www.google.com/recaptcha/api2/demo",
"websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
}
}

Field task untuk setiap jenis tugas ada di halaman-halaman di bawah Jenis tugas dan harga.

Jenis asinkron:

{
"errorId": 0,
"taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006"
}

Simpan taskId, lalu mulai memanggil getTaskResult setelah 5 detik.

Jenis sinkron:

{
"errorId": 0,
"status": "ready",
"taskId": "2376919c-1863-11ec-a012-94e6f7355a0b",
"solution": {
"text": "LMResm"
}
}

Gagal:

{
"errorId": 1,
"errorCode": "ERROR_TASK_NOT_SUPPORTED",
"errorDescription": "任务类型不正确或不受支持"
}

Server memeriksa permintaan dengan urutan berikut dan mengembalikan error pertama yang ditemukan, tanpa pemotongan poin:

  1. Body berupa JSON yang valid: ERROR_REQUEST_FORMATS
  2. clientKey disertakan: ERROR_REQUIRED_FIELDS
  3. clientKey ada: ERROR_KEY_DOES_NOT_EXIST
  4. Tidak sedang dijeda otomatis: ERROR_IP_BLOCKED_5MIN (lihat Batas tugas bersamaan dan jeda otomatis)
  5. Saldo lebih dari 10 poin: ERROR_ZERO_BALANCE
  6. task disertakan: ERROR_TASK_ABSENT
  7. task.type ada: ERROR_TASK_NOT_SUPPORTED
  8. Semua field wajib terisi: ERROR_REQUIRED_FIELDS (errorDescription menyebutkan field yang kurang)
  9. Untuk tugas gambar, gambarnya valid: ERROR_ZERO_CAPTCHA_FILESIZE, ERROR_IMAGE_TYPE_NOT_SUPPORTED, dan lainnya

Membuat tugas dan melakukan polling hasilnya (jenis asinkron):

curl -s https://api.yescaptcha.com/createTask \
-H 'Content-Type: application/json' \
-d '{
"clientKey": "YOUR_CLIENT_KEY",
"task": {
"type": "NoCaptchaTaskProxyless",
"websiteURL": "https://www.google.com/recaptcha/api2/demo",
"websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
}
}'
# Returns {"errorId":0,"taskId":"..."}; then poll every 5 seconds:
curl -s https://api.yescaptcha.com/getTaskResult \
-H 'Content-Type: application/json' \
-d '{"clientKey": "YOUR_CLIENT_KEY", "taskId": "TASK_ID"}'