API

Прежде чем внедрить свой собственный Death By Captcha Клиент HTTP API, пожалуйста, серьезно подумайте о использовании API сокета с одним из наших официальных клиентов, перечисленных выше.

URL API http://api.dbcapi.me/api/. Путь URL Изменения в зависимости от желаемого действия. Все ответы от запросов, сделанных на API, имеют две общие поля:

• status — Запрос статус. 0 Если во время внутренней обработки запросов не было ошибок, 255 в противном случае.
• error — Короткое объяснение произошла ошибка. Возвращается только тогда, когда статус составляет 255.

Для получения подробной информации о правильном пути URL и других возвращенных полей для конкретного действия см. В разделе ниже.

All API responses are returned URL-encoded by default. If JSON encoding is desired, include application/json in the Accept header of your request. Note that boolean true will be returned as 1 in URL-encoded responses and as true in JSON-encoded responses. Boolean false will be returned as 0 in URL-encoded responses and as false in JSON-encoded responses.

Что такое «обычные проверки»?

Эта форма CAPTCHA основана на изображении и требует ввода последовательности букв или цифр из искаженного изображения.

Чтобы загрузить CAPTCHA, отправьте POST-запрос multipart/form-data на http://api.dbcapi.me/api/captcha. Запрос должен содержать следующие поля:

• username — Ваше Death By Captcha имя пользователя.
• password — Ваш Death By Captcha пароль.
• captchafile — изображение капчи.

Если вы используете аутентификацию токена:

• authtoken — Ваш Death By Captcha токен аутентификации.
• captchafile — изображение капчи.

captchafile Должен быть предоставлен либо необработанный файл изображения CAPTCHA, либо изображение CAPTCHA, закодированное в Base64 с префиксом base64:. Размер файла изображения ограничен 180 КБ. При кодировании изображения в Base64 его размер не должен превышать 120 КБ. Поддерживаемые форматы изображений: JPG, PNG, GIF и BMP.

Вот форма HTML, которая справляется:

<form action="http://api.dbcapi.me/api/captcha"method="post" enctype="multipart/form-data">
    <input type="text"     name="username" value="">
    <input type="password" name="password" value="">
    <input type="file"     name="captchafile">
</form>

Или использование аутентификации токена:

<form action="http://api.dbcapi.me/api/captcha"method="post" enctype="multipart/form-data">
    <input type="text"     name="authtoken" value="">
    <input type="file"     name="captchafile">
</form>

Вот эквивалент команды curl:

curl --header 'Expect: ' -F username=YOUR_USERNAME  -F password=YOUR_PASSWORD  -F captchafile=@YOUR_CAPTCHA_FILENAME http://api.dbcapi.me/api/captcha

Или использование аутентификации токена:

curl --header 'Expect: ' -F authtoken=YOUR_AUTHTOKEN  -F captchafile=@YOUR_CAPTCHA_FILENAME http://api.dbcapi.me/api/captcha

base64-encoded captchafile должно выглядеть следующим образом:

base64:R0lGODlhAQABAIABAAAAAP///yH5BAEAAAEALAAAAAABAAEAAAICTAEAOw==

Вы получите один из следующих ответов HTTP:

• 303 See Other Если ваша Captcha была успешно загружена, location HTTP Header укажет вам на загруженную страницу состояния CAPTCHA, вы можете перейти location на Получите загруженный статус CAPTCHA. Кроме того, будут возвращены следующие поля:
  
  • captcha — удостоверение личности загруженной капты.
  • is_correct — 1 Если ответ был идентифицирован для этой капчи или он все еще обрабатывается, 0, если обработка закончена и не может быть найдено.
  • text — Капча ответ. Пустая строка означает, что капча еще не решена.
  URL -кодированный пример:

  status=0&captcha=123&is_correct=1&text=

  Пример кодирования JSON:

  { "status": 0, "captcha": 123, "is_correct": 1, "text": "" }

• 403 Forbidden Если ваша Death By Captcha были отклонены, или у вас недостаточно кредитов.
• 400 Bad Request Если ваш запрос не последовал приведенной выше спецификации, или CAPTCHA была отклонена за то, что он не является действительным изображением.
• 500 Internal Server Error Если что -то случилось на нашей стороне, мешало вам загрузить капчу; Если вы уверены, что отправляете правильно структурированные запросы с действительными изображениями CAPTCHA, но проблема сохраняется, пожалуйста, свяжитесь с нашей живой поддержкой и расскажите им подробно, как воспроизвести проблему.
• 503 Service Temporarily Unavailable Когда наш сервис перегружен, попробуйте еще раз позже.

На этом этапе captcha, которую вы только что загрузили, возможно, еще не была разгадана! Если вы не получили ответ в поле text ответа сервера, вам нужно опросить его. См. Опрос статуса загруженного CAPTCHA для получения дополнительной информации.

Чтобы получить загруженный статус Captcha, выпустите запрос получить запрос на получение http://api.dbcapi.me/api/captcha/%CAPTCHA_ID%, где %CAPTCHA_ID% - это идентификатор загруженной вами CAPTCHA, полученный во время загрузки CAPTCHA. На этот раз вам не нужно предоставить свои учетные данные Death By Captcha. Ответ будет содержать код HTTP 200 OK и те же поля, что и в ответе 303 Смотри другое из раздела Загрузка CAPTCHA.

Если CAPTCHA еще не решена, клавиша text будет пустой. Вам нужно будет продолжать опросить этот ответ. Пример ответов:

• Ответ с URL-кодировкой правильно решенной капчи

  status=0&captcha=1234&is_correct=1&text=tyrone+slothrop

• Ответ с кодировкой JSON правильно решенной капчи

  { "captcha": 1234, "is_correct": true,"status": 0, "text": "tyrone slothrop" }

• Ответ, кодируемый JSON неправильно решенной капчи,

  { "captcha": 1234, "is_correct": false, "status": 0, "text": "?" }

• Кодированный отклик о несуществующей капче

  { "captcha": 0, "status": 0 }

  Если вы получите этот ответ, подтвердите, что идентификатор CAPTCHA, который вы используете для опроса для ответа, возвращается, когда он был загружен. Если проблема сохраняется, не стесняйтесь свяжитесь с нами.

Пожалуйста, не опросите статус капчи более одного раза за пару секунд.
Это считается злоупотреблением и может привести к бану.
Сохраните свою и нашу пропускную способность.

Если вы думаете, что ваша Captcha была неверно решена, сообщите об этом Death By Captcha, чтобы вернуть ваши деньги. Для этого выпустите запрос POST в http://api.dbcapi.me/api/captcha/%CAPTCHA_ID%/report С следующими полями:

• username — Ваше Death By Captcha имя пользователя.
• password — Ваш Death By Captcha пароль.

Или использование токена аутентификации:

• authtoken — Ваш Death By Captcha токен аутентификации.

Ответ будет:

• 200 OK Если отчет был завершен. В этом случае ваши кредиты будут возвращены. Тело ответа будет таким же, как и для опроса (или загрузки), но поле is_correct будет 0. Пример:

  { "captcha": 1234, "is_correct": false,"status": 0, "text": "tyrone slothrop" }

• 503 Service Unavailable Если отчет не может быть завершен. Это может быть связано с тем, что:
  1) captcha, соответствующая предоставленному идентификатору, не была загружена пользователем, сообщающим его;
  2) ваш пользователь запрещен;
  3) отчет был сделан более часа после того, как если бы было загружено. В этом случае вы не будете возвращены.

Злоупотребление этой функцией заставит вас забанить!

Чтобы проверить ваш кредитный баланс, выпустите запрос на получение или публикацию в http://api.dbcapi.me/api со следующими полями:

• username — Ваше Death By Captcha имя пользователя.
• password — Ваш Death By Captcha пароль.

Или использование токена аутентификации:

• authtoken — Ваш Death By Captcha токен аутентификации.

При успешной аутентификации вы получите 200 OK Ответ с вашей Death By Captcha сведениями учетной записи, либо URL-, кодированные, со следующими полями:

• user — Ваш Death By Captcha идентификатор учетной записи;
• rate — Сколько мы взимаем с вас за один правильно решенную капчу, в US¢;
• balance — Ваш текущий кредитный баланс, в US¢.
• is_banned — 1 Если пользователь запрещен, 0, если нет.

Пример, кодируемый JSON:

{ "is_banned": false, "status": 0, "rate": 0.139,"balance": 455.23, "user": 43122 }