Установка кода виджета IQChannels на сайте

Виджет позволяет интегрировать функцию мессенджера на веб-сайт.

Принцип работы

Виджет состоит из двух компонентов:

• Подключаемый JavaScript-файл с API для взаимодействия с виджетом;
• Сам виджет, открывающийся в скрытом <iframe> поверх сайта.

После инициализации скрипт добавляет скрытый iFrame. API предоставляет интерфейс для управления виджетом (открытие, закрытие и пр.). Виджет занимает фиксированное положение справа на экране и добавляет отступ к основному контенту страницы, чтобы не перекрывать его.

1. Установка IQChannels

Предположим, система установлена локально и доступна по адресу:

• http://localhost:3001/

Пример встроенного виджета доступен по адресу:

• http://localhost:3001/widget/example.html

2. Размещение скрипта на сайте

2.1 Загрузка API

Добавьте скрипт виджета в тег <head> HTML-документа:

<script type="text/javascript" src="http://localhost:3001/widget/widget.min.js"></script>

2.2 Инициализация виджета

Виджет может быть подключен:

• в защищённой зоне (например, интернет-банк);
• в анонимной версии (публичный сайт).

2.2.1 Защищённая зона

Укажите название канала и авторизационные данные. Разместите скрипт в <body>:

<script type="text/javascript">
    var widget = new IQChannelsWidget({
        channel: 'support',
        credentials: 'user-token',
        mode: 'web'
    });
</script>

Пояснения:

• channel — имя канала в IQChannels типа «Внутренний чат»: значение поля «На английском:» из настроек канала (например, support);
• credentials — авторизационные данные пользователя.

При выходе пользователя из защищённой зоны необходимо вызвать:

widget.logout();

2.2.2 Анонимная версия

Если доступ публичный (например, маркетинговый сайт), используйте упрощённую инициализацию:

<script type="text/javascript">
    var widget = new IQChannelsWidget({
        channel: 'support'
    });
</script>

• credentials — не указывается: анонимный режим включается инициализацией виджета без credentials;
• канал используется тот же — «Внутренний чат»;
• Вызов logout() не требуется — пользователь может удалить переписку самостоятельно из браузера.

3. Ограничение доменов (опционально)

Настройка на сервере

По умолчанию виджет открывается с любого домена. При необходимости системный администратор может ограничить перечень доменов в конфигурационном файле сервера IQChannels — списки allowed_origins и allowed_referers. Настройка опциональна: если списки заданы, запросы с чужих доменов отклоняются сервером.

4. Проверка

Откройте сайт и проверьте, что виджет инициализируется корректно и открывается.

5. Дополнительная настройка и стилизация

См. Стилизация виджета — вы можете изменять стили, иконки, поведение.

6. Настройка push-уведомлений

Инструкции по интеграции push-уведомлений для Android и iOS приведены здесь.