createTask : создание задачи
Описание
Метод создает задачу на решение выбранного типа капчи. В параметрах указываются данные для авторизации клиента, типизированная информация о задаче и при необходимости дополнительные параметры.
https://api.capmonster.cloud/createTask
формат запроса: JSON POST
Для пользователей из России также доступен альтернативный адрес метода:
https://ru.api.capmonster.cloud/createTask
Он предназначен для снижения риска сетевых ошибок и блокировки запросов. При его использовании изменяется только адрес метода; параметры запроса, формат JSON POST, логика работы API и структура ответа остаются без изменений.
Параметры запроса
clientKey
Type: String
Обязательный: Да
Уникальный ключ вашей учетной записи, API ключ (найти можно здесь)
task
Type: Объект задачи
Обязательный: Да
Массив данных о задаче. Список типов задач капч приведён в следующем разделе.
callbackUrl
Type: String
Обязательный: Нет
Веб-адрес для отправки результата задачи капчи. Данные отправляются POST запросом: на этот адрес приходит готовое решение задачи, поэтому отдельно опрашивать метод getTaskResult не требуется.
Тело запроса содержит поля ответа getTaskResult, в том числе solution (решение задачи) и cost (стоимость решения в долларах США, USD), а также дополнительно поле taskId (тип String, идентификатор задачи).
Содержимое ответа не проверяется и сервер должен успеть принять запрос за 2 секунды, затем соединение закрывается.
Пример использования функции callbackUrl:
{
"clientKey": "API_KEY",
"task": {
"type": "RecaptchaV2Task",
"websiteURL": "https://lessons.zennolab.com/captchas/recaptcha/v2_simple.php?level=high",
"websiteKey": "6Lcg7CMUAAAAANphynKgn9YAgA4tQ2KI_iqRyTwd"
},
"callbackUrl": "https://yourwebsite.com/callback"
}
Пример тела запроса, который CapMonster Cloud отправляет на callbackUrl (solution - решение задачи, cost - стоимость решения в USD):
{
"solution": {
"text": "answer"
},
"cost": 0.0003,
"status": "ready",
"taskId": "7654321",
"errorId": 0,
"errorCode": null,
"errorDescription": null
}
Примеры запросов
Задача решения обычной капчи с изображением
{
"clientKey":"API_KEY",
"task":
{
"type":"ImageToTextTask",
"body":"BASE64_BODY_HERE!"
}
}
Задача решения ReCaptcha2
{
"clientKey":"API_KEY",
"task":
{
"type":"RecaptchaV2Task",
"websiteURL":"https://lessons.zennolab.com/captchas/recaptcha/v2_simple.php?level=high",
"websiteKey":"6Lcg7CMUAAAAANphynKgn9YAgA4tQ2KI_iqRyTwd"
}
}
Структура ответа
errorId
Type: Integer
Обязательный: Да
Идентификатор ошибки.
0 - ошибок нет, задача успешно создана, идентификатор задачи находится в параметре taskId
1 - ошибка, информация о ней находится в свойстве errorCode
errorCode
Type: String
Обязательный: Нет
Код ошибки. См. глоссарий ошибок.
taskId
Type: Integer
Обязательный: Да
Идентификатор задания для последующего использования в методе getTaskResult.
Пример ответа
Ответ БЕЗ ошибки
{
"errorId": 0,
"taskId": 7654321
}
Ответ, содержащий ошибку
{
"errorId": 1,
"errorCode": "ERROR_KEY_DOES_NOT_EXIST",
"errorDescription": "Account authorization key not found in the system or has incorrect format",
"taskId": 0
}
