#1108: Параметры инициализации виджетов

Отредактирована: 19 дней назад

Симптомы

Какие есть параметры инициализации виджета и в какой последовательности они применяются?

Решение

Встраиваемые виджеты в Swarmica могут быть настроены в соответствии с требуемым пользовательским опытом в том приложении, куда виджет встраивается.

Порядок применения

Настройки для параметров применяются по следующей логике:

Настройки пользователя, которые он/она задали в своем профиле Swarmica (например, язык)
Параметры, переданные в URL встраивания (см. пример ниже, значения в src после знака ?)
Настройки, заданные администратором Swarmica в настройках соответствующего канала
Настройки по умолчанию

Пример кода встраивания виджета:

<!-- start embedded Swarmica widget script -->
  <iframe src="https://your.swarmica.domain/widgets/index.html?id=atTpw53B55dob5xu&locale=ru&auth_provider=email&button_color=%23933c44&telegram_link=http%3A%2F%2Ft.me%2Flink&max_link=https%3A%2F%2Fmax.ru%2Flink&helpcenter_url=https%3A%2F%2Fdomain.tld%2Fhelp" id="123qwe" style="position: fixed; right: 12px; bottom: 12px; width: 56px; height: 56px; overflow: hidden; "
    allowTransparency="true"
    frameborder="0"
    allowTransparency="true" frameborder="0"></iframe>
  <script src="https://your.swarmica.domain/widgets/render.js"></script>
  <script>
    const iframe = document.getElementById("123qwe")
    iframe.onload = () => {
      renderWidget("123qwe")
    }
  </script>
  <!-- end embedded Swarmica widget scripts -->

Доступные параметры

Параметр	Значение по умолчанию	Возможные значения
locale - язык интерфейса	en	en, ru
auth_provider - провайдер авторизации по умолчанию	email	email - авторизация по email + password, code - авторизация по otp коду, для такого варианта необходимо еще передавать параметр otpdata, anonymous - без авторизации
otpdata - данные для OTP-авторизации	не установлено	Строка с данными для входа по одноразовому коду. Обязателен при `auth_provider=code`. Передаётся в URL встраивания; содержит OTP-код.
button_color - цвет кнопки открытия виджета	#93BEE6	HEX код цвета. В url добавляется в виде %93BEE6 (button_color=%93BEE6)
telegram_link - ссылка на канал в Telegram	не установлено	ссылка на телеграм, если не установлено - выбор опции Телеграм не отображается в виджете. Ожидается полный URL с https://
max_link - ссылка на канал в Max	не установлено	ссылка на Max, если не установлено - выбор опции Max не отображается в виджете. Ожидается полный URL с https://
helpcenter_url - ссылка на базу знаний	не установлено	ссылка на базу знаний. Ожидается полный URL с https://
open - открывать или нет виджет сразу	false	true - открывать виджет сразу, false - отображать только кнопку
fullscreen - разворачивать виджет на весь экран без возможности свернуть	false	true - разворачивать на весь экран, false - показывать сворачиваемым окошком
page - стартовая страница виджета	не установлено	chats - список чатов, last_chat - последний открытый чат, new_chat - новый чат. Если не установлено, то первая страница - это выбор приложения внутри виджета
allow_logout - показывать кнопку выхода из учетной записи или нет (появилось в версии v5.7.1)	false	true - показывать кнопку и позволять выходить из учетной записи, false - не показывать кнопку выхода (при этом выход из учетной записи доступен программно)
logout_on_init - производить выход из учетной записи при инициализации виджета, появилось в версии v5.9.2	false	true - выполнять выход из текущей учётной записи при инициализации виджета. Полезно, если в рамках одной сессии приложения виджет используется для авторизации разных пользователей через otpdata. false - не выполнять автоматический выход при инициализации.