Yandex SmartCaptcha в приложении на Android

Чтобы встроить SmartCaptcha в приложение на Android:

1. Создайте JavaScript Interface.
2. Настройте WebView для работы с капчей.
3. Получите результат прохождения капчи.

Перед началом работыПеред началом работы

1. Разместите HTML-страницу на своем сервере или воспользуйтесь страницей на сервере Yandex Cloud — https://smartcaptcha.cloud.yandex.ru/webview).
2. Создайте капчу.
3. На вкладке Обзор получите ключи капчи:
   • Ключ клиента — для загрузки страницы с капчей;
   • Ключ сервера — для получения результата прохождения капчи.

Создайте JavaScript InterfaceСоздайте JavaScript Interface

1. Создайте класс, который будет принимать сообщения с помощью функции обратного вызова от веб-страницы с капчей.

2. Определите метод onGetToken(token: String) с аннотацией @JavascriptInterface. Он вызывается, когда веб-страница возвращает токен прохождения капчи:

   class WebJsInterface {
   
     @JavascriptInterface
     fun onGetToken(token: String) {
       //Ваш код.
     }
   }
   

Настройте WebView для работы с капчейНастройте WebView для работы с капчей

1. Создайте WebView и добавьте его на экран.

2. Загрузите в WebView URL веб-страницы с капчей.

3. Вставьте в URL query-параметр sitekey=<ключ_клиентской_части>:

   val webView = findViewById<WebView>(R.id.webViewCaptcha)
   webView.loadUrl("URL_страницы_с_капчей?sitekey=<ключ_клиентской_части>")
   

4. Добавьте в WebView созданный JavaScript Interface. Укажите вторым параметром NativeClient — это имя, на которое веб-страница будет отправлять сообщения с помощью функции обратного вызова:

   settings.javaScriptEnabled = true // Включает выполнение JavaScript.
   addJavascriptInterface(WebJsInterface(), "NativeClient")
   

Получите результат прохождения капчиПолучите результат прохождения капчи

1. Сохраните токен прохождения капчи. Он вернется в методе onGetToken(token: String), когда сервис обработает попытку.

2. Для проверки токена отправьте POST-запрос на адрес https://smartcaptcha.cloud.yandex.ru/validate, передав параметры в формате x-www-form-urlencoded:

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

   Примечание

   Данная логика должна выполняться на бэкенде. В само Android-приложение секретный ключ secret попасть не должен.

   Пример запроса:

   https://smartcaptcha.cloud.yandex.ru/validate?secret=<ключ_сервера>&ip=<IP-адрес_пользователя>&token=<токен>
   

3. Получите ответ с сервера. Он содержит JSON-объект с полями status и message.

   Например:

   • Это человек:

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

   • Это робот:

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