createTask – Aufgabe erstellen

createTask erstellt eine Erkennungsaufgabe; mit task.type legen Sie fest, welches Captcha gelöst werden soll. Asynchrone Typen liefern eine taskId, mit der Sie anschließend das Ergebnis über getTaskResult abrufen; synchrone Typen liefern das Ergebnis direkt.

Hinweis

Der Punkteabzug erfolgt, sobald die Aufgabe erfolgreich erstellt wurde. Ihr Guthaben muss über 10 Punkten liegen, um eine Aufgabe zu erstellen. Bei fehlgeschlagenen oder abgelaufenen Aufgaben erfolgt automatisch eine Punkteerstattung.

POSThttps://api.yescaptcha.com/createTaskGlobaler EndpointKopieren

POSThttps://cn.yescaptcha.com/createTaskChina-EndpointKopieren

Anfragefelder

Feld	Typ	Pflicht	Beschreibung
clientKey	string	Ja	Ihr ClientKey, zu kopieren im Dashboard auf yescaptcha.com
task	object	Ja	Das Aufgabenobjekt. Es muss type enthalten; die übrigen Felder richten sich nach dem Aufgabentyp (siehe die Seiten der einzelnen Aufgabentypen)
softID	integer	Nein	Entwickler-ID. Geben Sie sie an, wenn andere Ihre Software verwenden, um eine Entwicklerbeteiligung zu erhalten, siehe Entwicklerbeteiligung

Anfragebeispiele

Ein Bild-Captcha erkennen (synchron):

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

Ein reCAPTCHA-v2-Token abrufen (asynchron):

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

Die task-Felder der einzelnen Aufgabentypen finden Sie auf den Seiten unter Aufgabentypen und Preise.

Antwort

Asynchrone Typen:

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

Merken Sie sich die taskId und fragen Sie nach 5 Sekunden mit getTaskResult ab.

Synchrone Typen:

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

Fehler:

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

Reihenfolge der Prüfungen

Der Server prüft eine Anfrage in dieser Reihenfolge und gibt beim ersten gefundenen Problem den entsprechenden Fehlercode zurück. Es erfolgt kein Punkteabzug:

1. Der Request-Body ist gültiges JSON: ERROR_REQUEST_FORMATS
2. clientKey ist angegeben: ERROR_REQUIRED_FIELDS
3. clientKey existiert: ERROR_KEY_DOES_NOT_EXIST
4. Der Schlüssel ist nicht automatisch pausiert: ERROR_IP_BLOCKED_5MIN (siehe Limit gleichzeitiger Aufgaben und automatische Pausierung)
5. Das Guthaben liegt über 10 Punkten: ERROR_ZERO_BALANCE
6. task ist angegeben: ERROR_TASK_ABSENT
7. task.type existiert: ERROR_TASK_NOT_SUPPORTED
8. Alle Pflichtfelder sind vorhanden: ERROR_REQUIRED_FIELDS (errorDescription nennt das fehlende Feld)
9. Bei Bildaufgaben ist das Bild gültig: ERROR_ZERO_CAPTCHA_FILESIZE, ERROR_IMAGE_TYPE_NOT_SUPPORTED und weitere

Vollständiges Beispiel

Eine Aufgabe erstellen und das Ergebnis regelmäßig abfragen (asynchroner Typ):

curl

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"}'

Python

solve.py

import os
import 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"])

Node.js

solve.mjs

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);