createTask

タスクを作成し、そのIDを返します。タスクが受け付けられた時点でその種類の料金が残高から差し引かれ、タスクが失敗した場合は返金されます。

POSThttps://unlock-api.com/createTask

Content-Type: application/jsonでPOSTしてください。taskのフィールドはタスクの種類によって異なります。「タスクの種類」を参照してください。

リクエストパラメータ

clientKey

String必須

アカウントページにある32文字のAPIキーです。

task

Object必須

taskオブジェクトです。そのtypeフィールドによって、ほかに必要なフィールドが決まります。タスクの種類

callbackUrl

String任意

公開されたhttp(s)アドレスです。タスクが完了または失敗すると、結果がJSONでこのアドレスにPOSTされます。

softId

Integer任意

アプリケーションIDで、タスクと一緒に保存されます。appIdも同じフィールドとして受け付けます。

リクエスト

POST /createTask

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

レスポンス

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

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

レスポンスフィールド

errorId

Integer

リクエストが成功した場合は0、失敗した場合は1です。

taskId

Integer

タスクIDです。

errorCode

String

errorIdが1のときのエラー名です。

errorDescription

String

エラーの短い説明(英語)です。

コードサンプル

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

このメソッドが返すエラー

ERROR_KEY_DOES_NOT_EXIST
キーが間違っています。アカウントページからもう一度コピーしてください。(in.phpとres.php: ERROR_WRONG_USER_KEY)
ERROR_IP_NOT_ALLOWED
アカウントの許可リストにないIPからのリクエストです。アカウントページでIPを追加してください。
ERROR_IP_BANNED
このアカウントはブロックされています。アカウントページからサポートにお問い合わせください。
ERROR_TOO_MANY_REQUESTS
リクエストが多すぎます。結果確認の間隔を5秒ごとにしてください。
ERROR_ZERO_BALANCE
残高がタスクの料金に足りません。入金してください。課金はされていません。
ERROR_NO_SLOT_AVAILABLE
現在リクエストが多すぎるため、タスクを受け付けられませんでした。数秒後にもう一度お試しください。課金はされていません。
ERROR_TASK_NOT_SUPPORTED
タスクの種類が不明か、無効になっています。種類名を確認してください。
ERROR_BAD_PARAMETERS
必須フィールドがないか、形式が正しくありません。
ERROR_PAGEURL
websiteURLまたはpageurlがないか、完全なhttp(s)アドレスではありません。
ERROR_BAD_PROXY
プロキシタスクにはproxyAddressとproxyPortが必要です。
ERROR_ZERO_CAPTCHA_FILESIZE
画像がないか、小さすぎます。
ERROR_TOO_BIG_CAPTCHA_FILESIZE
画像が100 KBを超えています。
ERROR_IMAGE_TYPE_NOT_SUPPORTED
画像が有効なbase64ではありません。