UNLOCK API
createTask

createTask

建立任務並回傳其 ID。任務被接受時,從餘額扣除該任務類型的費用;任務失敗則退回。
POSThttps://unlock-api.com/createTask
以 POST 發送,Content-Type: application/json。task 欄位取決於任務類型;請參閱任務類型。

請求參數

clientKey
String必填
你的 API 密鑰,32 個字元,在賬戶頁面上。
task
Object必填
任務物件。其 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
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")

此方法可能回傳的錯誤