Проверить капчу

SmartCaptcha, проверив запрос, присваивает ему идентификатор — одноразовый токен. По этому токену вы можете запросить у сервиса результат проверки запроса пользователя. Токен действителен 5 минут. По истечении этого времени токен становится недействительным и пользователю необходимо снова пройти проверку.

После проверки токен загружается в элемент <input type="hidden" name="smart-token" value="<токен>" ...> на странице пользователя. Например:

<div id="captcha-container" class="smart-captcha" ...>
    <input type="hidden" name="smart-token" value="dD0xNjYyNDU3NDMzO2k9MmEwMjo2Yjg6YjA4MTpiNTk3OjoxOjFiO0Q9MjVCREY1RDgzMDBERjQ3QjExNkUyMDJDNjJFNEI3Q0Y0QjYzRkRDNzJEMkV********DNjMxODgzMUM0REZBNzI1QUE1QzUwO3U9MTY2MjQ1NzQzMzk5MTEwNjQxNTtoPTg4MWRjMDc2YzE3MjkxNGUwNDgwMTVkYzhl********">
    ...
</div>

Где:

• <div id="captcha-container" class="smart-captcha" ...> — элемент div с виджетом.
• value — значение токена.

Чтобы узнать результат проверки, отправьте POST-запрос на адрес https://smartcaptcha.yandexcloud.net/validate, передав параметры в формате x-www-form-urlencoded:

secret=<ключ_сервера>&token=<токен>&ip=<IP-адрес_пользователя>

Где:

• secret — ключ сервера;
• token — одноразовый токен, полученный после прохождения проверки;
• ip — IP-адрес пользователя, с которого пришел запрос на проверку токена. Этот параметр не обязателен, однако мы просим передавать IP-адрес пользователя при запросах. Это помогает улучшить качество работы SmartCaptcha.

Ответ сервисаОтвет сервиса

В ответ сервис пришлет JSON-объект с полями status и message. Когда поле status принимает значение ok, в JSON-объект добавляется поле host. Оно показывает, на каком сайте была пройдена проверка. Например:

1. Это человек. Проверка пройдена на сайте example.com:

   {
       "status": "ok",
       "message": "",
       "host": "example.com"
   }
   

2. Это человек. Проверка пройдена на сайте example.com через порт 8080:

   {
       "status": "ok",
       "message": "",
       "host": "example.com:8080"
   }
   

3. Пустое поле host. Может означать, что облако заблокировано, или произошел внутренний сбой сервиса:

   {
       "status": "ok",
       "message": "",
       "host": ""
   }
   

4. Это робот:

   {
       "status": "failed",
       "message": ""
   }
   

5. Запрос с поддельным или поврежденным токеном. Это робот:

   {
       "status": "failed",
       "message": "Token invalid or expired."
   }
   

Ошибки в запросеОшибки в запросе

Если запрос к https://smartcaptcha.yandexcloud.net/validate оформлен некорректно, сервис вернет ошибку. Например:

1. Запрос без ключа сервера:

   {
       "status": "failed",
       "message": "Authentication failed. Secret has not provided."
   }
   

2. Запрос без токена или с поврежденным токеном:

   {
       "status": "failed",
       "message": "Token invalid or expired."
   }