Документация

Добавьте сайт

Войдите в приложение, создайте сайт с названием и адресом, например https://example.com. Укажите домен без пути, параметров и порта. Каждый сайт получает свой публичный ключ.

Скопируйте код подключения из приложения. Публичный ключ маршрутизирует сбор для сайта; он не даёт доступ к кабинету или ответам посетителей.

Установите один тег

Разместите тег на страницах, которые хотите исследовать. Замените PUBLIC_SITE_KEY ключом из приложения.

<script src="https://wyli.ru/wyli.js" data-key="PUBLIC_SITE_KEY"
        data-consent="required" defer></script>

Пример ожидает согласия посетителя: data-consent="required" оставляет запуск за вашим интерфейсом согласия. Без этого атрибута SDK запускается после загрузки. Код и вызовы методов должны выполняться после загрузки SDK.

Если сайт использует Content Security Policy, разрешите нужные скрипты, стили, соединения и ресурсы подключённых разделов на адресах вашей установки. Проверяйте правила в браузере; одного разрешения основного файла может быть недостаточно.

Запускайте после согласия

Когда SDK загрузился и посетитель согласился на выбранный сбор, вызовите:

await window.wyli.start();

Повторный start() не создаёт ещё один запуск. Do Not Track и Global Privacy Control блокируют запуск общего сборщика и опросов. Эти сигналы нельзя обходить повторным вызовом.

В текущем SDK нет метода остановки уже запущенного сбора. Для последующих загрузок после отзыва согласия исключите тег или не вызывайте запуск; перезагрузите страницу без активного сборщика. Ранее отправленные данные удаляются отдельно.

Задайте важные действия

Отправляйте события после подтверждённого действия, а не просто нажатия, если целью является завершение формы.

window.wyli.event('lead_created', {form: 'callback'});

Название — непустая строка до 100 символов. Параметры — объект. Не отправляйте пароли, контакты, содержимое переписки, платёжные сведения или токены доступа.

Для связи действий авторизованного пользователя используйте обезличенный идентификатор, а не электронную почту:

window.wyli.identify('customer_7f3a');

Затем настройте цели и воронки в нужном разделе приложения. Обработку данных проверяйте по реальному тестовому визиту.

Подключите обратную связь

Откройте обратную связь, выберите сайт, создайте опрос, задайте путь и опубликуйте его. Доступны 1–8 вопросов: оценка, NPS, комментарий до 1000 символов и выбор одного из 2–12 вариантов.

Для загрузки опросов и показа по событию добавьте data-feedback="true" в существующий тег. Отдельный ключ не нужен. Имя события должно точно совпадать с настройкой опубликованного опроса.

Для явного показа после запуска используйте идентификатор опубликованного опроса:

await window.wyli.feedback('PUBLIC_SURVEY_ID');

Явный вызов также может загрузить модуль по запросу. До запуска, при DNT/GPC, неподходящем пути или отсутствии опубликованного опроса форма не откроется. Опросы не показываются только от посещения страницы: нужен вызов или настроенное событие.

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

Проверьте весь путь

1. Откройте подключённый сайт и выполните сценарий согласия.
2. Просмотрите страницу, перейдите дальше и вызовите тестовое событие.
3. Проверьте появление визита и события в приложении; если запись доступна, откройте её и проверьте воспроизведение.
4. Для опроса отправьте тестовый ответ и проверьте нужную версию в обратной связи. Предпросмотр ответы не сохраняет.

status() помогает проверить запуск SDK, но состояние ready не доказывает, что запись уже обработана сервером. Проверяйте итог в приложении.

Подробный контракт методов — в справочнике API.