createTask

Premiers pas

Méthodes JSON

Guides

Tâches à token

Tâches image et audio

createTask

Crée une tâche et renvoie son id. Le prix du type de tâche est prélevé sur le solde quand la tâche est acceptée, et rendu si la tâche échoue.

POSThttps://unlock-api.com/createTask

Envoyez un POST avec Content-Type: application/json. Les champs de la tâche dépendent du type de tâche ; voir Types de tâches.

Paramètres de la requête

clientKey

StringObligatoire

Votre clé API, 32 caractères, depuis la page de compte.

task

ObjectObligatoire

Objet tâche. Son champ type détermine les autres champs nécessaires. Types de tâches

callbackUrl

StringFacultatif

Adresse http(s) publique. Quand la tâche est terminée ou échoue, le résultat y est envoyé par POST en JSON.

softId

IntegerFacultatif

L'id de votre application, enregistré avec la tâche. appId est accepté comme le même champ.

Requête

POST /createTask

{
  "clientKey": "YOUR_API_KEY",
  "task": {
    "type": "TurnstileTaskProxyless",
    "websiteURL": "https://example.com/login",
    "websiteKey": "0x4AAAAAAAC3DHQFLr1GavRN"
  }
}

Réponse

{
  "errorId": 0,
  "taskId": 1001
}

{
  "errorId": 1,
  "errorCode": "ERROR_ZERO_BALANCE",
  "errorDescription": "Your balance is too low for this task. Add funds and try again."
}

Champs de la réponse

errorId

Integer

0 si la requête a réussi, 1 sinon.

taskId

Integer

Id de la tâche.

errorCode

String

Nom de l'erreur quand errorId vaut 1.

errorDescription

String

Courte explication de l'erreur en anglais.

Exemples de code

import time, requests

API = "https://unlock-api.com"
KEY = "YOUR_API_KEY"

task = requests.post(f"{API}/createTask", json={
    "clientKey": KEY,
    "task": {
      "type": "TurnstileTaskProxyless",
      "websiteURL": "https://example.com/login",
      "websiteKey": "0x4AAAAAAAC3DHQFLr1GavRN"
    }
}).json()
if task["errorId"]:
    raise SystemExit(task["errorCode"])

for _ in range(60):   # 60 x 5 s = the 5 minute task limit
    time.sleep(5)
    r = requests.post(f"{API}/getTaskResult", json={"clientKey": KEY, "taskId": task["taskId"]}).json()
    if r["errorId"]:
        raise SystemExit(f"{r['errorCode']}: {r.get('errorDescription', '')}")   # failed tasks are refunded
    if r["status"] == "ready":
        print(r["solution"]["token"])
        break
else:
    raise SystemExit("timed out")

const API = "https://unlock-api.com";
const KEY = "YOUR_API_KEY";
const post = (path, body) => fetch(API + path, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify(body) }).then((r) => r.json());

const task = await post("/createTask", {
  clientKey: KEY,
  task: {
    "type": "TurnstileTaskProxyless",
    "websiteURL": "https://example.com/login",
    "websiteKey": "0x4AAAAAAAC3DHQFLr1GavRN"
  },
});
if (task.errorId) throw new Error(task.errorCode);

let solution = null;
for (let n = 0; n < 60 && !solution; n++) { // 60 x 5 s = the 5 minute task limit
  await new Promise((r) => setTimeout(r, 5000));
  const r = await post("/getTaskResult", { clientKey: KEY, taskId: task.taskId });
  if (r.errorId) throw new Error(r.errorCode + ": " + r.errorDescription); // failed tasks are refunded
  if (r.status === "ready") solution = r.solution;
}
if (!solution) throw new Error("timed out");
console.log(solution.token);

<?php
$api = "https://unlock-api.com";
$key = "YOUR_API_KEY";
function post($url, $body) {
  $c = curl_init($url);
  curl_setopt_array($c, [CURLOPT_POST => true, CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Content-Type: application/json"], CURLOPT_POSTFIELDS => json_encode($body)]);
  return json_decode(curl_exec($c), true);
}
$task = post("$api/createTask", ["clientKey" => $key, "task" => json_decode('{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com/login","websiteKey":"0x4AAAAAAAC3DHQFLr1GavRN"}', true)]);
if ($task["errorId"]) exit($task["errorCode"]);
for ($n = 0; $n < 60; $n++) { // 60 x 5 s = the 5 minute task limit
  sleep(5);
  $r = post("$api/getTaskResult", ["clientKey" => $key, "taskId" => $task["taskId"]]);
  if ($r["errorId"]) exit($r["errorCode"] . ": " . $r["errorDescription"]); // failed tasks are refunded
  if ($r["status"] === "ready") break;
}
if ($r["status"] !== "ready") exit("timed out");
print_r($r["solution"]["token"]);

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"time"
)

const api = "https://unlock-api.com"
const key = "YOUR_API_KEY"

func post(method string, body map[string]any) map[string]any {
	b, _ := json.Marshal(body)
	res, err := http.Post(api+"/"+method, "application/json", bytes.NewReader(b))
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	var out map[string]any
	json.NewDecoder(res.Body).Decode(&out)
	return out
}

func main() {
	task := post("createTask", map[string]any{
		"clientKey": key,
		"task": map[string]any{
			"type": "TurnstileTaskProxyless",
			"websiteURL": "https://example.com/login",
			"websiteKey": "0x4AAAAAAAC3DHQFLr1GavRN",
		},
	})
	if task["errorId"].(float64) != 0 {
		panic(task["errorCode"])
	}
	for n := 0; n < 60; n++ { // 60 x 5 s = the 5 minute task limit
		time.Sleep(5 * time.Second)
		r := post("getTaskResult", map[string]any{"clientKey": key, "taskId": task["taskId"]})
		if r["errorId"].(float64) != 0 {
			panic(r["errorCode"]) // failed tasks are refunded
		}
		if r["status"] == "ready" {
			fmt.Println(r["solution"])
			return
		}
	}
	panic("timed out")
}

import java.net.URI;
import java.net.http.*;
import java.util.regex.*;

public class Solve {
  static final String API = "https://unlock-api.com", KEY = "YOUR_API_KEY";
  static final HttpClient HTTP = HttpClient.newHttpClient();

  static String post(String method, String json) throws Exception {
    var req = HttpRequest.newBuilder(URI.create(API + "/" + method))
        .header("Content-Type", "application/json")
        .POST(HttpRequest.BodyPublishers.ofString(json)).build();
    return HTTP.send(req, HttpResponse.BodyHandlers.ofString()).body();
  }

  public static void main(String[] args) throws Exception {
    String task = "{\"type\":\"TurnstileTaskProxyless\",\"websiteURL\":\"https://example.com/login\",\"websiteKey\":\"0x4AAAAAAAC3DHQFLr1GavRN\"}";
    String created = post("createTask", "{\"clientKey\":\"" + KEY + "\",\"task\":" + task + "}");
    Matcher id = Pattern.compile("\"taskId\":(\\d+)").matcher(created);
    if (!id.find()) throw new RuntimeException(created);
    for (int n = 0; n < 60; n++) { // 60 x 5 s = the 5 minute task limit
      Thread.sleep(5000);
      String r = post("getTaskResult", "{\"clientKey\":\"" + KEY + "\",\"taskId\":" + id.group(1) + "}");
      if (r.contains("\"errorId\":1")) throw new RuntimeException(r); // failed tasks are refunded
      if (r.contains("\"status\":\"ready\"")) { System.out.println(r); return; }
    }
    throw new RuntimeException("timed out");
  }
}

using System.Net.Http.Json;
using System.Text.Json;

const string Api = "https://unlock-api.com";
const string Key = "YOUR_API_KEY";
var http = new HttpClient();

async Task<JsonElement> Post(string method, object body) =>
    await (await http.PostAsJsonAsync($"{Api}/{method}", body)).Content.ReadFromJsonAsync<JsonElement>();

var task = await Post("createTask", new {
    clientKey = Key,
    task = JsonSerializer.Deserialize<JsonElement>("""
        {"type":"TurnstileTaskProxyless","websiteURL":"https://example.com/login","websiteKey":"0x4AAAAAAAC3DHQFLr1GavRN"}
        """)
});
if (task.GetProperty("errorId").GetInt32() != 0) throw new Exception(task.GetProperty("errorCode").GetString());

for (var n = 0; n < 60; n++) { // 60 x 5 s = the 5 minute task limit
    await Task.Delay(5000);
    var r = await Post("getTaskResult", new { clientKey = Key, taskId = task.GetProperty("taskId").GetInt64() });
    if (r.GetProperty("errorId").GetInt32() != 0) throw new Exception(r.GetProperty("errorCode").GetString()); // failed tasks are refunded
    if (r.GetProperty("status").GetString() == "ready") { Console.WriteLine(r.GetProperty("solution")); return; }
}
throw new Exception("timed out");

curl -s https://unlock-api.com/createTask \
  -H "Content-Type: application/json" \
  -d '{"clientKey":"YOUR_API_KEY","task":{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com/login","websiteKey":"0x4AAAAAAAC3DHQFLr1GavRN"}}'
# {"errorId":0,"taskId":1001}

curl -s https://unlock-api.com/getTaskResult \
  -H "Content-Type: application/json" \
  -d '{"clientKey":"YOUR_API_KEY","taskId":1001}'
# {"errorId":0,"status":"processing"}  then  {"errorId":0,"status":"ready","solution":{...},"cost":"0.001"}

Erreurs que cette méthode peut renvoyer

ERROR_KEY_DOES_NOT_EXIST
La clé est incorrecte. Copiez-la de nouveau depuis la page de compte. (in.php et res.php : ERROR_WRONG_USER_KEY)
ERROR_IP_NOT_ALLOWED
La requête provient d'une IP absente de la liste autorisée du compte. Ajoutez l'IP sur la page de compte.
ERROR_IP_BANNED
Ce compte est bloqué. Contactez le support depuis la page de compte.
ERROR_TOO_MANY_REQUESTS
Trop de requêtes. Espacez les vérifications de résultat à une toutes les 5 secondes.
ERROR_ZERO_BALANCE
Le solde ne couvre pas la tâche. Ajoutez des fonds ; rien n'a été facturé.
ERROR_NO_SLOT_AVAILABLE
Trop de requêtes en ce moment, la tâche n'a pas pu être acceptée. Réessayez dans quelques secondes ; rien n'a été facturé.
ERROR_TASK_NOT_SUPPORTED
Le type de tâche est inconnu ou désactivé. Vérifiez le nom du type.
ERROR_BAD_PARAMETERS
Un champ obligatoire est manquant ou mal formaté.
ERROR_PAGEURL
websiteURL ou pageurl est manquant ou n'est pas une adresse http(s) complète.
ERROR_BAD_PROXY
Une tâche avec proxy exige proxyAddress et proxyPort.
ERROR_ZERO_CAPTCHA_FILESIZE
L'image est manquante ou trop petite.
ERROR_TOO_BIG_CAPTCHA_FILESIZE
L'image dépasse 100 KB.
ERROR_IMAGE_TYPE_NOT_SUPPORTED
L'image n'est pas un base64 valide.

createTask

Paramètres de la requête

Requête

Réponse

Champs de la réponse

Exemples de code

Erreurs que cette méthode peut renvoyer

Connexion avec votre token de compte

Connexion avec votre token de compte