Referência da API para resolver CAPTCHA

POST /createTask Criar uma tarefa

Corpo: clientKey e um objeto task. O tipo da tarefa define os outros campos; veja Tipos de tarefa. Resposta: errorId 0 e taskId, ou errorId 1 com 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 Obter o resultado

Corpo: clientKey e taskId. Enquanto a tarefa roda: status processing. Quando termina: status ready com a solution e o cost. Uma tarefa com falha responde errorId 1 com seu 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 o saldo

Corpo: clientKey. Resposta: balance em dólares americanos.

{"clientKey":"YOUR_API_KEY"}

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

Informar uma resposta errada

reportIncorrectRecaptcha e reportIncorrectImageCaptcha aceitam clientKey e taskId e respondem success. Eles são aceitos por compatibilidade com bibliotecas existentes; um aviso não altera a cobrança.

Enviar uma tarefa: in.php

Campos: key, method e os campos do tipo de CAPTCHA. Resposta: OK|ID, ou com json=1 {"status":1,"request":"ID"}. Os erros voltam pelo nome, 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"}

Obter a resposta: res.php

action=get&id=ID retorna OK|ANSWER quando resolvida e CAPCHA_NOT_READY enquanto está em andamento. action=get2 inclui o custo. ids=ID1,ID2 consulta até 100 tarefas de uma vez. action=getbalance retorna o saldo. action=reportbad e reportgood são aceitos.

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 Criar e aguardar: getToken

Mesmo corpo do createTask. A chamada aguarda até 50 segundos e retorna a mesma resposta do getTaskResult. Se a tarefa ainda estiver em andamento, a resposta é status processing com o taskId; continue consultando o 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

Adicione callbackUrl ao createTask (ou pingback ao in.php) e o resultado é enviado para lá quando a tarefa termina: um corpo JSON como o do getTaskResult com taskId ou, no in.php, um corpo de formulário id=…&code=…. Só endereços públicos são chamados, uma vez, com tempo limite de 5 segundos; o resultado também continua disponível 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"}

Estatísticas

getQueueStats retorna as tarefas aguardando e sendo resolvidas agora e o tempo médio de resolução na última hora. getSpendingStats retorna seu volume e gasto por hora em um dia UTC (date em unix time). test devolve o corpo que recebe.

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 IPs permitidos

Se você definir uma lista de IPs permitidos na página da conta, requisições de outros IPs recebem ERROR_IP_NOT_ALLOWED.