VK Cloud logo

Справочник SDK для веб-приложений

Системные требования

Поддерживаемые браузеры:

  • Google Chrome версии 52 и выше;
  • Microsoft Edge версии 79 и выше;
  • Firefox версии 57 и выше;
  • Safari версии 11 и выше;
  • Opera версии 39 и выше;
  • Яндекс Браузер версии 16.9 и выше.

Отобразить капчу

Метод captchaWidget.show() отображает виджет капчи пользователю в веб-приложении. Виджет капчи отображается во всплывающем окне (iframe).

Параметры метода:

Параметр

Обязательный

Тип

Описание

container

Справочник SDK для веб-приложений

HTMLElement

HTML-элемент, в котором нужно отобразить виджет с капчей

view

Справочник SDK для веб-приложений

string

Вид капчи. Возможные значения:

  • popup — всплывающее окно;
  • block — блок

iframeSrc

Справочник SDK для веб-приложений

string

Ссылка для запуска виджета во фронтенде вашего приложения, полученная в параметре link в ответе метода GET /captchaNotRobot.createSession. Содержит сессионный токен и метаданные:

  • domain — домен, на котором будет использована капча;
  • session_token — сессионный токен;
  • variant — вид отображения капчи (block или popup)

captchaType

Справочник SDK для веб-приложений

string

Тип капчи. Возможное значение — type_1

autofocus

Справочник SDK для веб-приложений

boolean

Признак автофокусировки капчи. Используется только для значения block в аргументе view. Возможные значения:

  • true — автофокус включен (по умолчанию), фокус на странице будет перемещен на веб-элемент с капчей;
  • false — автофокус выключен, фокус на странице останется на том же месте, где и был до появления веб-элемента с капчей

scheme

Справочник SDK для веб-приложений

string

Цветовая схема виджета с капчей. Возможные значения:

  • light — светлая;
  • dark — темная.

По умолчанию соответствует цветовой схеме страницы или приложения, куда интегрирована капча

lang

Справочник SDK для веб-приложений

string

Язык локализации. Если не указан, значение будет определено на сервере. Возможные значения:

  • ru — русский;
  • be — белорусский;
  • de — немецкий;
  • en — английский;
  • es — испанский;
  • fr — французский;
  • kk — казахский;
  • pl — польский;
  • tr — турецкий;
  • uk — украинский;
  • uz — узбекский

onClose

Справочник SDK для веб-приложений

() => void

Callback-уведомление о закрытии капчи

Метод возвращает promise-объект с результатом прохождения капчи:

promise resolve <ТОКЕН_ПРОХОЖДЕНИЯ_КАПЧИ> promise reject <ОШИБКА>

Здесь:

  • <ТОКЕН_ПРОХОЖДЕНИЯ_КАПЧИ> — токен успешного прохождения капчи, если пользователь прошел капчу;
  • <ОШИБКА> — ошибка close, если пользователь закрыл окно капчи.

Закрыть капчу

Метод captchaWidget.close() закрывает виджет капчи. Метод ничего не возвращает в ответе.

Пример вызова метода:

captchaWidget.close();