Документация

Документация для решения SmartCaptcha

1. Создание задачи SmartCaptcha

Чтобы создать задачу SmartCaptcha, отправьте POST-запрос на адрес http://app.botlab.me/create с указанием API-ключа в заголовке X-API-Key. В теле запроса передайте данные в формате JSON.

Запрос

  • URL: http://app.botlab.me/create
  • Метод: POST
  • Заголовок: X-API-Key: API KEY
  • Content-Type: application/json

Тело запроса (JSON):

  • type - * Обязательно. Тип задачи, в данном случае "SmartCaptcha"
  • click - * Обязательно. Изображение области клика в формате Base64.
  • task - * Обязательно. Изображение с порядком задания в формате Base64.
  • app_id - Идентификатор приложения разработчика (можно найти в разделе реферальная система для разработчиков)
{
  "type": "SmartCaptcha",
  "click": "CLICK_BASE_64",
  "task": "TASK_BASE_64"
}

Рекомендации по передаче изображений

Для обеспечения качественного решения задачи SmartCaptcha, рекомендуется загружать изображения области клика (CLICK_BASE_64) и порядка задания (TASK_BASE_64) путем их скачивания с источника и последующего преобразования в формат Base64. Это помогает избежать потери и обеспечить точность передаваемых данных в запросе для создания задачи.

Ответ

После успешного создания задачи получите уникальный идентификатор задачи.

{
  "status": 1,
  "response": "9051d4b4-0000-44d3-a4c2-db0215227862"
}
  • status - статус выполнения запроса (1 - успешно, 0 - ошибка).
  • response - идентификатор задания / код ошибки

2. Получение результатов задачи SmartCaptcha

Чтобы получить результаты обработки задачи SmartCaptcha, отправьте POST-запрос на адрес http://app.botlab.me/result с указанием API-ключа в заголовке X-API-Key. В теле запроса передайте идентификатор задачи из предыдущего запроса.

Запрос

  • URL: http://app.botlab.me/result
  • Метод: POST
  • Заголовок: X-API-Key: API KEY
  • Тело запроса (JSON):
  • id - идентификатор созданной задачи

{ "id": "9051d4b4-0000-44d3-a4c2-db0215227862" }

Ответ

Получите результаты обработки задачи SmartCaptcha в виде координат.

{
  "status": 1,
  "response": "coordinates:x=34.7,y=108.0;x=234.3,y=72.3;x=149.1,y=107.7;x=43.0,y=30.3;x=137.4,y=32.0"
}
  • status - статус выполнения запроса (1 - успешно, 0 - ошибка).
  • response - координаты в формате x и y для каждой точки / код ошибки.

Если в ответе вы получаете значение CAPCHA_NOT_READY, это означает, что результаты еще не готовы. В таком случае, рекомендуется подождать от 2 до 10 секунд и повторить запрос на получение результатов. Повторяйте запрос, пока не получите успешный результат (status равен 1) или другой статус, указывающий на ошибку.

Для владельцев своего софта

После регистрации приложение вы получите свой softId, на создание задачи щлем POST-запрос на адрес http://app.botlab.me/create

{
  "type": "SmartCaptcha",
  "click": "CLICK_BASE_64",
  "app_id": "идентификатор приложения",
  "task": "TASK_BASE_64"
}