Установка Яндекс SmartCaptcha PRO
Получите быструю помощь по покупке, оплате, установке, настройке, продлению и другим вопросам, оставив заявку
💡 Нужна консультация и помощь по работе?
Системные требования
Для работы модуля необходимы:
установленная система «1С-Битрикс: Управление сайтом» или Корпоративный портал (1С-Битрикс24: Интернет-магазин + CRM).
PHP версии 8.2 или выше;
доступ сайта к сервисам Yandex SmartCaptcha;
Client Key и Server Key, полученные в сервисе Yandex SmartCaptcha;
права администратора сайта.
Перед установкой рекомендуется создать резервную копию файлов и базы данных сайта стандартными средствами «1С-Битрикс».
Установка модуляУстановите решение через Маркетплейс «1С-Битрикс».
После загрузки решения:
Перейдите в административную часть сайта.
Откройте раздел:
Настройки → Настройки продукта → Модули
Найдите модуль «Установка Яндекс SmartCaptcha PRO».
Нажмите «Установить».
Дождитесь завершения установки.
Во время установки модуль:
регистрируется в системе «1С-Битрикс»;
регистрирует необходимые обработчики событий;
копирует JavaScript- и CSS-файлы;
создает первоначальные настройки.
Модуль устанавливается выключенным и не влияет на формы сайта до заполнения ключей и ручного включения.
Получение ключей Yandex SmartCaptchaПеред настройкой модуля создайте CAPTCHA в сервисе Yandex SmartCaptcha и получите:
Client Key — публичный клиентский ключ, используемый для отображения виджета;
Server Key — секретный серверный ключ, используемый для проверки полученного токена.
При создании CAPTCHA укажите домены сайтов, на которых будет использоваться модуль.
Для многосайтовой установки можно использовать отдельные ключи для каждого сайта.
Настройка модуляПосле установки перейдите в раздел:
Настройки → Настройки продукта → Настройки модулей → Установка Яндекс SmartCaptcha PRO
На странице будет отображен список сайтов текущей установки «1С-Битрикс».
Для нужного сайта выберите действие «Редактировать».
Основные параметрыВключить модуль
Выберите «Да», чтобы активировать замену стандартной CAPTCHA на выбранном сайте.
Включайте модуль после заполнения Client Key и Server Key.
Клиентский ключ — Client KeyУкажите публичный ключ Yandex SmartCaptcha.
Он используется браузером для загрузки и отображения виджета.
Серверный ключ — Server KeyУкажите секретный ключ Yandex SmartCaptcha.
Он используется сервером сайта для проверки токена пользователя. Не размещайте Server Key в шаблонах сайта и не передавайте его третьим лицам.
Режим виджетаДоступны два режима:
Видимый — виджет SmartCaptcha отображается непосредственно в форме;
Невидимый — проверка запускается при попытке отправить форму.
Для первоначальной настройки рекомендуется использовать видимый режим. После проверки работы форм можно переключить модуль в невидимый режим.
Язык виджетаЗначение auto включает автоматический выбор языка.
Также можно принудительно выбрать один из поддерживаемых языков, например:
ru;
en;
be;
kk;
tt;
uk;
uz;
tr.
Параметр определяет положение служебного элемента Yandex SmartCaptcha в невидимом режиме.
Например:
bottom-right;
bottom-left;
bottom-center;
top-right.
По умолчанию используется значение bottom-right.
Дополнительные параметрыМаски исключений
Позволяют отключить модуль на отдельных страницах.
Каждая маска указывается с новой строки. Символ * заменяет любое количество символов.
Примеры:
/personal/*/catalog/import/
/services/legacy-form/
На страницах, соответствующих указанным маскам, SmartCaptcha не подключается и продолжает работать стандартная CAPTCHA Битрикс.
Сообщение об ошибкеМожно указать текст, который будет отображаться при неуспешной проверке пользователя.
Если поле оставить пустым, используется стандартное сообщение:
«Не удалось подтвердить, что вы не робот. Пройдите проверку еще раз».
Таймаут серверной проверкиОпределяет, сколько времени сайт будет ожидать ответ от сервера Yandex.
Допустимые значения: от 1 до 10 секунд.
Значение по умолчанию: 2 секунды.
Таймаут загрузки JavaScriptОпределяет максимальное время ожидания загрузки клиентского скрипта Yandex SmartCaptcha.
Допустимые значения: от 1000 до 15000 миллисекунд.
Значение по умолчанию: 5000 миллисекунд.
Если скрипт не загрузится за указанное время, модуль восстановит стандартную CAPTCHA Битрикс.
Политика при недоступности YandexДоступны два режима:
allow — продолжить обработку формы при временной недоступности серверной проверки Yandex;
deny — отклонить отправку формы, если серверную проверку выполнить невозможно.
Для сайтов, где важнее непрерывная доступность форм, рекомендуется allow.
Для форм с повышенными требованиями к защите рекомендуется deny.
ЖурналированиеПри включении параметра сведения о проверках и технических ошибках записываются в стандартный журнал событий «1С-Битрикс».
Просмотреть записи можно через действие «Журнал» на странице настроек модуля или в разделе:
Настройки → Инструменты → Журнал событий
Сохранение настроекПосле заполнения параметров нажмите:
«Сохранить» — сохранить настройки и вернуться к списку сайтов;
«Применить» — сохранить настройки и остаться на текущей странице.
Настройки сохраняются отдельно для каждого сайта.
Проверка установкиПосле сохранения настроек:
Откройте действие «Диагностика» для настраиваемого сайта.
Убедитесь, что модуль активен.
Убедитесь, что Client Key и Server Key отмечены как заполненные.
Откройте публичную страницу со стандартной CAPTCHA Битрикс.
Проверьте, что вместо изображения с кодом отображается Yandex SmartCaptcha.
Успешно пройдите проверку и отправьте форму.
Попробуйте отправить форму без прохождения проверки.
Проверьте работу AJAX-форм, всплывающих окон и других динамических форм.
При включенном журналировании проверьте записи в журнале событий.
Проверку рекомендуется выполнить для следующих форм, если они используются на сайте:
регистрация;
восстановление пароля;
обратная связь;
комментарии;
отзывы;
оформление заказа;
пользовательские формы со стандартной CAPTCHA Битрикс.
Модуль автоматически создает контейнер:
.delement-yandexcaptcha-containerВ большинстве шаблонов дополнительная настройка не требуется.
При необходимости внешний вид и отступы можно изменить в CSS шаблона сайта. Не рекомендуется изменять внутреннюю структуру самого виджета Yandex SmartCaptcha.
Возможные причины отсутствия виджетаSmartCaptcha не будет отображаться, если:
модуль выключен для текущего сайта;
не заполнен Client Key или Server Key;
текущий адрес соответствует маске исключения;
форма не содержит стандартных полей CAPTCHA Битрикс;
страница относится к административной части сайта;
отсутствует доступ к сервисам Yandex SmartCaptcha;
домен сайта не разрешен в настройках ключа.
При ошибке загрузки SmartCaptcha модуль должен восстановить стандартную CAPTCHA Битрикс, чтобы пользователь сохранил возможность отправить форму.