Referencia de la API para resolver CAPTCHA

POST /createTask Crear una tarea

Cuerpo: clientKey y un objeto task. El tipo de tarea define los demás campos; consulta Tipos de tarea. Respuesta: errorId 0 y taskId, o errorId 1 con errorCode.

POST https://unlock-api.com/createTask
{"clientKey":"YOUR_API_KEY","task":{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com","websiteKey":"0x4AAAAAAAC3DHQFLr1GavRN"}}

{"errorId":0,"taskId":1001}
{"errorId":1,"errorCode":"ERROR_ZERO_BALANCE","errorDescription":"..."}

POST /getTaskResult Obtener el resultado

Cuerpo: clientKey y taskId. Mientras la tarea está en curso: status processing. Cuando termina: status ready con la solución y el costo. Una tarea fallida responde errorId 1 con su errorCode.

POST https://unlock-api.com/getTaskResult
{"clientKey":"YOUR_API_KEY","taskId":1001}

{"errorId":0,"status":"processing"}
{"errorId":0,"status":"ready","solution":{"token":"0.zrSnRHO7h0..."},"cost":"0.0012","createTime":1791640000,"endTime":1791640011,"solveCount":1}

POST /getBalance Consultar el saldo

Cuerpo: clientKey. Respuesta: saldo en dólares estadounidenses.

{"clientKey":"YOUR_API_KEY"}

{"errorId":0,"balance":42.5}

Reportar una respuesta incorrecta

reportIncorrectRecaptcha y reportIncorrectImageCaptcha aceptan clientKey y taskId y responden success. Se aceptan por compatibilidad con librerías existentes; un reporte no cambia el cobro.

Enviar una tarea: in.php

Campos: key, method y los campos del tipo de CAPTCHA. Respuesta: OK|ID, o con json=1 {"status":1,"request":"ID"}. Los errores se devuelven con su nombre, como ERROR_ZERO_BALANCE.

POST https://unlock-api.com/in.php
key=YOUR_API_KEY&method=hcaptcha&sitekey=SITE_KEY&pageurl=https://example.com&json=1

OK|1001
{"status":1,"request":"1001"}

Obtener la respuesta: res.php

action=get&id=ID devuelve OK|ANSWER cuando está resuelta y CAPCHA_NOT_READY mientras se trabaja. action=get2 agrega el costo. ids=ID1,ID2 consulta hasta 100 tareas a la vez. action=getbalance devuelve el saldo. action=reportbad y reportgood se aceptan.

GET https://unlock-api.com/res.php?key=YOUR_API_KEY&action=get&id=1001
CAPCHA_NOT_READY
OK|P1_eyJ0eXAiOiJKV1Qi...

GET https://unlock-api.com/res.php?key=YOUR_API_KEY&action=getbalance
42.5

POST /getToken Crear y esperar: getToken

El mismo cuerpo que createTask. La llamada espera hasta 50 segundos y devuelve la misma respuesta que getTaskResult. Si la tarea sigue en curso, la respuesta es status processing con su taskId; sigue consultando getTaskResult.

POST https://unlock-api.com/getToken
{"clientKey":"YOUR_API_KEY","task":{"type":"TurnstileTaskProxyless","websiteURL":"https://example.com","websiteKey":"0x4AAAA..."}}

{"errorId":0,"taskId":1001,"status":"ready","solution":{"token":"0.zrSnRHO7h0..."},"cost":"0.000725"}

Callbacks de resultado

Agrega callbackUrl a createTask (o pingback a in.php) y el resultado se envía ahí cuando termina la tarea: un cuerpo JSON como el de getTaskResult con taskId, o en in.php un cuerpo de formulario id=…&code=…. Solo se llama a direcciones públicas, una vez, con un tiempo límite de 5 segundos; el resultado también sigue disponible por consulta.

{"clientKey":"YOUR_API_KEY","callbackUrl":"https://your.server/captcha-result","task":{...}}

POST https://your.server/captcha-result
{"errorId":0,"taskId":1001,"status":"ready","solution":{...},"cost":"0.0005"}

Estadísticas

getQueueStats devuelve las tareas en espera y en resolución en este momento, y el tiempo promedio de resolución de la última hora. getSpendingStats devuelve tu volumen y gasto por hora de un día UTC (date en tiempo unix). test devuelve el cuerpo que recibe.

POST https://unlock-api.com/getQueueStats     {"clientKey":"..."}  ->  {"errorId":0,"waiting":3,"solving":12,"speed":6.4,"total":15}
POST https://unlock-api.com/getSpendingStats  {"clientKey":"...","date":1791590400}  ->  {"errorId":0,"data":[{"dateFrom":...,"volume":120,"money":0.06},...]}
POST https://unlock-api.com/test              {"anything":1}  ->  {"errorId":0,"received":{"anything":1}}

Lista de IP permitidas

Si defines una lista de IP permitidas en la página de cuenta, las solicitudes desde otras IP reciben ERROR_IP_NOT_ALLOWED.