Настройка ресурса и сайта

Предварительные настройки

• Ваш сайт должен работать по протоколу HTTPS. Web Push не работает на HTTP-сайтах.

• В платформе Altcraft должен быть активирован функционал веб-пикселей и push-уведомлений.

  • Для облачной версии: Если вы используете облачную версию Altcraft, обратитесь в поддержку по адресу support@altcraft.com с запросом на включение push-уведомлений и пикселей для вашего аккаунта.
  • Для On-Premises: Push-уведомления и пиксели должны быть активированы для всех аккаунтов, с которых планируется отправка. Зайдите в Панель администратора — Управление аккаунтами, нажмите на нужный аккаунт и активируйте push-уведомления и пиксели. Подробнее в соответствующей статье документации для администраторов.

Создание ресурса

Ресурс — это объект в платформе, который связывает базу данных подписчиков с каналом коммуникации. После сохранения ресурса станет доступен Toolkit — набор файлов для работы Web Push на вашем сайте.

подсказка

Для каждого сайта должен быть создан отдельный ресурс.

В платформе создайте или выберите Базу данных, в которой будут храниться подписчики на push-уведомления.

Добавьте push-канал для существующего ресурса или создайте новый. Введите Имя и Описание ресурса.

В поле URL веб-сайта, формы или приложения укажите адрес сайта, на котором происходит подписка на push и с которого будут отправляться уведомления. Этот адрес вносится в файл manifest.json, необходимый для настройки пушей, поэтому при некорректном адресе push-уведомления работать не будут.

В поле Трекинг домен по умолчанию укажите домен, на котором запущен трекинг Altcraft. Этот домен обрабатывает переходы по ссылкам в сообщениях.

Далее выберите желаемые браузеры и провайдеров для каждой платформы. Ниже станут доступны настройки для выбранных провайдеров.

Подробная инструкция для каждой платформы доступна в этом разделе документации. Без конфигурации провайдеров push-уведомления работать не будут.

Подключение SDK на сайт

После того, как все настройки выполнены, сохраните ресурс. Для скачивания будет доступен Toolkit — набор файлов для работы Web Push на вашем сайте. Toolkit появится в разделе Установка.

к сведению

Toolkit сам по себе не вызывает окно подписки. Он содержит файлы и скрипты для работы с уведомлениями. Для показа предложения подписаться добавьте код, вызывающий функцию ak-push.js.

Установка файлов на сайт возможна двумя способами:

Способ 1: Динамический service worker

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

• manifest.json — данные о проекте для отправки push через Google Chrome
• service-worker.js — service worker, регистрируемый в браузерах пользователей

Файл service-worker.js является динамическим. Он автоматически обновляется при изменении настроек ресурса.

Пример service-worker.js

importScripts('https://pxl.test.com/service-worker.js?id=MXw3');

предупреждение

При изменении параметра URL веб-сайта, формы или приложения в используемом ресурсе необходимо повторно загрузить manifest.json на сайт.

Способ 2: Статичный Toolkit

В правой части интерфейса нажмите Загрузить, распакуйте архив и разместите файлы в корневой директории сайта. Toolkit состоит из четырех файлов:

• README.txt — инструкция по установке
• ak-push.js — скрипт для показа окна подписки
• manifest.json — данные о проекте
• service-worker.js — service worker

При использовании Toolkit можно изменить путь до service-worker.js. Откройте ak-push.js, найдите свойство swPath и укажите нужный путь.

предупреждение

При изменении настроек ресурса или провайдеров необходимо повторно загрузить Toolkit на сайт.

Добавление кода подписки

После установки Toolkit добавьте на сайт код для показа окна подписки:

<button id="init_sub">Подписаться на уведомления</button>

<script>
    document.getElementById('init_sub').addEventListener('click', function() {
        try {
            const akPush = new AKPush();
            akPush.initSubscription()
        }
        catch (e) {
            console.log(e);
        }
    });
</script>

Логика работы:

1. Пользователь нажимает на кнопку
2. Вызывается метод initSubscription
3. Всплывает системное окно браузера с предложением подписаться

Подписка на один ресурс происходит повторно для каждого браузера. У одного профиля может быть несколько активных push-подписок при подписке с разных браузеров.

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

подсказка

Через платформу Altcraft можно создать собственный попап с предложением подписки. Подробнее в статье Попап для подписки на push.