createTask — créer une tâche

createTask crée une tâche de reconnaissance ; task.type indique quel captcha résoudre. Les types asynchrones renvoient un taskId, que vous passez ensuite à getTaskResult pour récupérer le résultat ; les types synchrones renvoient directement le résultat.

Note

Les points sont débités à la création réussie de la tâche, et votre solde doit être supérieur à 10 points pour en créer une. Les tâches en échec ou expirées donnent lieu à un remboursement de points automatique.

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

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

Paramètres de la requête

Champ	Type	Obligatoire	Description
clientKey	string	Oui	Votre ClientKey, à copier depuis le tableau de bord de yescaptcha.com
task	object	Oui	L’objet de la tâche. Il doit contenir type ; les autres champs dépendent du type de tâche (voir la page de chaque type de tâche)
softID	integer	Non	ID développeur. Ajoutez le vôtre lorsque d’autres personnes utilisent votre logiciel pour recevoir une part développeur ; voir Part développeur

Exemples de requête

Lire un captcha image (synchrone) :

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

Obtenir un token reCAPTCHA v2 (asynchrone) :

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

Les champs de task de chaque type figurent dans les pages de Types de tâches et tarifs.

Réponse

Types asynchrones :

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

Conservez le taskId et commencez à appeler getTaskResult 5 secondes plus tard.

Types synchrones :

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

Échec :

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

Ordre des vérifications

Le serveur vérifie la requête dans cet ordre et renvoie le code d’erreur correspondant au premier problème rencontré, sans débit de points :

1. Le corps de la requête est du JSON valide : ERROR_REQUEST_FORMATS
2. clientKey est présent : ERROR_REQUIRED_FIELDS
3. clientKey existe : ERROR_KEY_DOES_NOT_EXIST
4. La clé n’est pas en suspension automatique : ERROR_IP_BLOCKED_5MIN (voir Limite de tâches simultanées et suspension automatique)
5. Le solde est supérieur à 10 points : ERROR_ZERO_BALANCE
6. task est présent : ERROR_TASK_ABSENT
7. task.type existe : ERROR_TASK_NOT_SUPPORTED
8. Tous les champs obligatoires sont présents : ERROR_REQUIRED_FIELDS (errorDescription indique le champ manquant)
9. Pour les tâches d’image, l’image est valide : ERROR_ZERO_CAPTCHA_FILESIZE, ERROR_IMAGE_TYPE_NOT_SUPPORTED, etc.

Exemple complet

Créer une tâche et interroger périodiquement (polling) le résultat (type asynchrone) :

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