Опции метода SPCaptcha.render()

В этом справочнике описаны опции, которые можно передать вторым аргументом метода SPCaptcha.render(container, options).

Опция Значение Что делает Обязательна

siteKey

Значение SiteKey, полученное вами от Servicepipe, например, O4FUxStKtioH1seP

Передаёт публичный ключ виджета. По этому ключу Servicepipe определяет, к какой интеграции относится виджет и какие настройки капчи нужно применить.

Да

language

ru или en.

По умолчанию: ru

Задаёт язык интерфейса капчи. Доступны два значения: ru (русский) и en (английский).

Если опция не указана, капча будет на русском.

Нет

callback

Ваша функция, принимающая токен

Задаёт функцию, которую SDK вызовет, если капча пройдена успешно. В эту функцию SDK передаст токен.

Нет.

Но токен всё равно должен быть получен. Сделать это можно одним из способов: через опцию callback либо responseField, событие success или метод SPCaptcha.getResponse.

onError

Ваша функция, принимающая объект ошибки

Задаёт функцию, которую SDK вызовет, если при работе виджета возникнет ошибка в браузере. В эту функцию SDK передаст объект с error.code и error.message.

Нет

onExpired

Ваша функция без аргументов

Задаёт функцию, которую SDK вызовет, когда срок действия уже полученного токена истечёт.

Нет

onReady

Ваша функция без аргументов

Задаёт функцию, которую SDK вызовет после создания виджета и его перехода в состояние готовности.

Нет

onChallengeVisible

Ваша функция без аргументов

Задаёт функцию, которую SDK вызовет, когда задание капчи станет видно пользователю.

Нет

onChallengeHidden

Ваша функция без аргументов

Задаёт функцию, которую SDK вызовет при скрытии задания капчи: например, после успешного прохождения, ошибки или закрытия модального окна пользователем.

Нет

responseField

true или false. Если опция не указана, поле не создаётся

Создаёт скрытое поле для токена внутри HTML-элемента виджета.

Если пользователь успешно пройдёт капчу, SDK запишет токен в это поле.

Нет.

Но токен всё равно должен быть получен. Сделать это можно одним из способов: через опцию callback либо responseField, событие success или метод SPCaptcha.getResponse.

responseFieldName

Имя поля, например sp-captcha-token.

По умолчанию: captcha-token

Задаёт имя скрытого поля с токеном, которое вы включили через responseField.

Если опция не указана, SDK создаст поле с именем по умолчанию — captcha-token.

Нет