Описание API

API позволяет интегрировать наш сервис для автоматизации распознавания текста с капч.

Последовательность действий для решения капчи:
  1. На странице Вашего профиля получите API Key.
  2. Отправьте POST запрос на https://cptch.net/in.php c необходимым параметрами для отправки капчи на наш сервер и постановки задачи на решение капчи. Вы получите ID капчи, по которому можно узнать решение капчи.
  3. Через пару секунд начните отправлять GET запрос на https://cptch.net/res.php, пока не будет возвращен ответ на решение капчи.
Наше API совместимо с другими сервисами по распознаванию капч.

Решение обычной капчи

Отправка изображения капчи
API Endpoint: POST https://cptch.net/in.php
Мы принимаем изображения двумя способами: файлом или base64-закодированные.
Параметр запроса Обязательно Описание
key да API-ключ, который необходимо получить на странице профиля.
method да Вариант передачи изображения.
post - отправка изображения с помощью multipart-формы
base64 - отправка изображения в base64-закодированном формате
file один из параметров необходим Файл с изображением капчи
body Изображение капчи в base64-кодированном формате
soft_id нет Номер приложения разработчика. Разработчики, интегрировавшие свое приложение с нашим сервисом, получают отчисления в размере от 30% стоимости запроса.
json нет Формат ответа от сервера:
0 - в виде простого текста
1 - в формате JSON
по умолчанию: 0
header_acao нет 1 - будет передан HTTP-заголовок Access-Control-Allow-Origin: * в ответ

В случае корректного запроса, сервер вернет ID капчи в виде простого текста, либо в формате JSON: OK|46289 или {"status":1,"request":"46289"}

Получение решения капчи
После отправки изображения на сервис необходимо получить результат решения капчи.
API Endpoint: GET https://cptch.net/res.php
Параметр Описание
key API-ключ, который необходимо получить на странице профиля.
action get - вариант для получения ответа на одну капчу
id ID капчи, полученный от https://cptch.net/in.php
json Формат ответа от сервера:
0 - в виде простого текста
1 - в формате JSON
по умолчанию: 0
header_acao 1 - будет передан HTTP-заголовок Access-Control-Allow-Origin: * в ответ
В случае, если капча уже решена, то будет возвращен ответ:
OK|TEXT или {"status":1,"request":"TEXT"}

Если капча еще не решена, то будет возвращен ответ CAPCHA_NOT_READY. В данном случае необходимо повторить запрос через несколько секунд.

Обработка ошибок
Для успешного взаимодействия с сервисом необходимо обрабатывать ошибки.
Ошибки in.php
Текст ошибки Значение
ERROR_WRONG_USER_KEY Проверьте передаваемый параметр key. Он должен соответствовать API-ключу.
ERROR_KEY_DOES_NOT_EXIST
ERROR_ZERO_BALANCE Пополните баланс для продолжения работы с сервисом.
ERROR_ZERO_CAPTCHA_FILESIZE Размер переданного изображения менее 100 байт, либо изображение не передано.
ERROR_TOO_BIG_CAPTCHA_FILESIZE Размер переданного изображения более 100 килобайт.
ERROR_UPLOAD Сервер не смог прочитать файл из вашего POST-запроса, либо запрос содержит некорректный base64. Проверьте также параметр method.

Ошибки res.php
Текст ошибки Значение
CAPCHA_NOT_READY Капча еще не решена. Подождите несколько секунд и повторите запрос.
ERROR_CAPTCHA_UNSOLVABLE Капчу решить не удалось. Деньги списаны не будут. Вы можете попробовать послать капчу еще раз.
ERROR_WRONG_USER_KEY Проверьте передаваемый параметр key. Он должен соответствовать API-ключу.
ERROR_KEY_DOES_NOT_EXIST
ERROR_WRONG_CAPTCHA_ID Вы отправили неверный ID капчи.
ERROR Не передан корректный параметр action.

Решение ReCaptcha v2

Отправка задачи на решение
API Endpoint: POST https://cptch.net/in.php
Параметр запроса Обязательно Описание
key да API-ключ, который необходимо получить на странице профиля.
method да userrecaptcha
googlekey да Параметр data-sitekey.
Можно получить, используя JavaScript на странице сайта:
document.querySelector(".g-recaptcha").getAttribute('data-sitekey')
pageurl да Полный URL страницы, на которой находится ReCaptcha
soft_id нет Номер приложения разработчика. Разработчики, интегрировавшие свое приложение с нашим сервисом, получают отчисления в размере от 30% стоимости запроса.
json нет Формат ответа от сервера:
0 - в виде простого текста
1 - в формате JSON
по умолчанию: 0
header_acao нет 1 - будет передан HTTP-заголовок Access-Control-Allow-Origin: * в ответ

В случае корректного запроса, сервер вернет ID капчи в виде простого текста, либо в формате JSON: OK|46289 или {"status":1,"request":"46289"}

Получение решения капчи
После отправки задачи на сервис необходимо получить результат решения капчи.
API Endpoint: GET https://cptch.net/res.php
Параметр Описание
key API-ключ, который необходимо получить на странице профиля.
action get - вариант для получения ответа на одну капчу
id ID капчи, полученный от https://cptch.net/in.php
json Формат ответа от сервера:
0 - в виде простого текста
1 - в формате JSON
по умолчанию: 0
header_acao 1 - будет передан HTTP-заголовок Access-Control-Allow-Origin: * в ответ
В случае, если капча уже решена, то будет возвращен ответ:
OK|03ACgFB9t9QWxd5Dh89YrlAqeVpP...

Если капча еще не решена, то будет возвращен ответ CAPCHA_NOT_READY. В данном случае необходимо повторить запрос через несколько секунд.
Полученный ответ необходимо вставить в поле ответа ReCaptcha v2, что можно также сделать с помощью конструкции JavaScript:
document.querySelector("#g-recaptcha-response").innerText = "123123"
Обработка ошибок
Для успешного взаимодействия с сервисом необходимо обрабатывать ошибки.
Ошибки in.php
Текст ошибки Значение
ERROR_WRONG_USER_KEY Проверьте передаваемый параметр key. Он должен соответствовать API-ключу.
ERROR_KEY_DOES_NOT_EXIST
ERROR_ZERO_BALANCE Пополните баланс для продолжения работы с сервисом.
ERROR_PAGEURL Не задан параметр pageurl.
ERROR_GOOGLEKEY Не задан параметр googlekey.

Ошибки res.php
Текст ошибки Значение
CAPCHA_NOT_READY Капча еще не решена. Подождите несколько секунд и повторите запрос.
ERROR_CAPTCHA_UNSOLVABLE Капчу решить не удалось. Деньги списаны не будут. Вы можете попробовать послать капчу еще раз.
ERROR_WRONG_USER_KEY Проверьте передаваемый параметр key. Он должен соответствовать API-ключу.
ERROR_KEY_DOES_NOT_EXIST
ERROR_WRONG_CAPTCHA_ID Вы отправили неверный ID капчи.
ERROR Не передан корректный параметр action.

Примеры


Если у вас что-то не получилось или вы нашли ошибку, смело пишите нам в поддержку support@cptch.net. Будем рады помочь вам!