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.
https://api.yescaptcha.com/createTaskEndpoint globalhttps://cn.yescaptcha.com/createTaskEndpoint TiongkokParameter permintaan
Section titled “Parameter permintaan”| 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 |
Contoh permintaan
Section titled “Contoh permintaan”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.
Respons
Section titled “Respons”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": "任务类型不正确或不受支持"}Urutan pemeriksaan
Section titled “Urutan pemeriksaan”Server memeriksa permintaan dengan urutan berikut dan mengembalikan error pertama yang ditemukan, tanpa pemotongan poin:
- Body berupa JSON yang valid:
ERROR_REQUEST_FORMATS clientKeydisertakan:ERROR_REQUIRED_FIELDSclientKeyada:ERROR_KEY_DOES_NOT_EXIST- Tidak sedang dijeda otomatis:
ERROR_IP_BLOCKED_5MIN(lihat Batas tugas bersamaan dan jeda otomatis) - Saldo lebih dari 10 poin:
ERROR_ZERO_BALANCE taskdisertakan:ERROR_TASK_ABSENTtask.typeada:ERROR_TASK_NOT_SUPPORTED- Semua field wajib terisi:
ERROR_REQUIRED_FIELDS(errorDescriptionmenyebutkan field yang kurang) - Untuk tugas gambar, gambarnya valid:
ERROR_ZERO_CAPTCHA_FILESIZE,ERROR_IMAGE_TYPE_NOT_SUPPORTED, dan lainnya
Contoh lengkap
Section titled “Contoh lengkap”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"}'import osimport time
import requests
API = "https://api.yescaptcha.com"CLIENT_KEY = os.environ["YESCAPTCHA_CLIENT_KEY"] # Read the clientKey from an environment variable
def call(method, payload): r = requests.post(f"{API}/{method}", json={"clientKey": CLIENT_KEY, **payload}, timeout=30) data = r.json() if data.get("errorId"): raise RuntimeError(f"{data.get('errorCode')}: {data.get('errorDescription')}") return data
def solve(task): task_id = call("createTask", {"task": task})["taskId"] for _ in range(36): # Poll every 5 seconds, for up to about 3 minutes time.sleep(5) result = call("getTaskResult", {"taskId": task_id}) if result.get("status") == "ready": return result["solution"] raise TimeoutError(task_id)
solution = solve({ "type": "NoCaptchaTaskProxyless", "websiteURL": "https://www.google.com/recaptcha/api2/demo", "websiteKey": "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",})print(solution["gRecaptchaResponse"])const API = 'https://api.yescaptcha.com';const CLIENT_KEY = process.env.YESCAPTCHA_CLIENT_KEY; // Read the clientKey from an environment variable
async function call(method, payload) { const res = await fetch(`${API}/${method}`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ clientKey: CLIENT_KEY, ...payload }), }); const data = await res.json(); if (data.errorId) throw new Error(`${data.errorCode}: ${data.errorDescription}`); return data;}
async function solve(task) { const { taskId } = await call('createTask', { task }); for (let i = 0; i < 36; i++) { // Poll every 5 seconds, for up to about 3 minutes await new Promise((r) => setTimeout(r, 5000)); const result = await call('getTaskResult', { taskId }); if (result.status === 'ready') return result.solution; } throw new Error(`timeout: ${taskId}`);}
const solution = await solve({ type: "NoCaptchaTaskProxyless", websiteURL: "https://www.google.com/recaptcha/api2/demo", websiteKey: "6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-",});console.log(solution.gRecaptchaResponse);