MaxNotify

**MaxNotify** — компонент для MODX Revolution 2, который отправляет сведения
о заказах miniShop2 в мессенджер MAX через официальный MAX Business API или через сервис (https://rumaxbot.ru).

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


## Возможности

— уведомление сразу после создания заказа miniShop2;
— уведомление при изменении статуса заказа;
— уведомления о заявках FormIt;
— уведомления о заявках SendIt;
— отдельное отключение источников miniShop2, FormIt и SendIt;
— фильтрация уведомлений по ID статусов;
— номер, сумма и состав заказа;
— имя, телефон и email покупателя;
— адрес доставки и комментарий клиента;
— название способа доставки и оплаты;
— ссылка на конкретный заказ в панели MODX;
— официальный MAX Business API и сервис rumaxbot.ru на выбор;
— отправка одному или нескольким чатам, каналам или пользователям;
— сообщения в формате Markdown или HTML;
— редактируемые чанки сообщений;
— запись ошибок API и соединения в журнал MODX.

## Требования

— MODX Revolution 2.8+;
— miniShop2 2.x+;
— PHP 7.2+;
— PHP cURL или включённый `allow_url_fopen`;
— токен официального MAX-бота или канал и API-ключ rumaxbot.ru.

Компонент проверен с MODX Revolution 2.8.8-pl и miniShop2 4.4.2-pl.

## Установка

1. Откройте в MODX раздел **Пакеты → Установщик**.
2. Найдите компонент **MaxNotify** в репозитории.
3. Нажмите **Скачать**, затем **Установить**.
4. После установки очистите кэш MODX.

## Настройка

Откройте **Системные настройки** и выберите пространство имён `maxnotify`.

Основные параметры:

— maxnotify.enabled — включает или отключает компонент;
— maxnotify.enable_minishop2 — уведомления miniShop2;
— maxnotify.enable_formit — уведомления FormIt;
— maxnotify.enable_sendit — уведомления SendIt;
— maxnotify.provider — rumaxbot или maxbusiness;
— maxnotify.format — формат markdown или html;
— maxnotify.timeout — таймаут API-запроса в секундах;
— maxnotify.notify_new_order — уведомления о новых заказах;
— maxnotify.notify_status_change — уведомления о смене статуса;
— maxnotify.statuses — ID статусов через запятую, пустое поле разрешает все;
— maxnotify.form_exclude_fields — технические поля форм, которые не нужно отправлять.

Подключение FormIt
Добавьте hook-сниппет maxNotifyFormIt в параметр &hooks после успешных
проверок формы.
Пример:

[[!FormIt?
    &hooks=`spam,email,maxNotifyFormIt,redirect`
    &emailTpl=`tpl.Email`
    &redirectTo=`12`
]]

Отключить отправку заявок FormIt можно настройкой maxnotify.enable_formit.
Заголовок сообщения меняется настройкой maxnotify.formit_title.

Подключение SendIt
Добавьте hook-сниппет maxNotifySendIt в цепочку успешной обработки SendIt,
если в вашей конфигурации SendIt используются hook-сниппеты. Сниппет также
умеет брать данные из $_POST, поэтому его можно вызывать после успешной
валидации формы.
Отключить отправку заявок SendIt можно настройкой maxnotify.enable_sendit.
Заголовок сообщения меняется настройкой maxnotify.sendit_title.

## Подключение официального MAX Business API

Официальное подключение доступно верифицированным организациям и ИП, которые являются резидентами РФ.

Создайте и верифицируйте профиль на платформе MAX для партнёров.
Создайте чат-бота и дождитесь прохождения модерации.
Получите токен в разделе Чат-боты → Перейти → Расширенные настройки → Настроить.
Добавьте бота в нужный чат или канал либо запустите личный диалог с ботом.
Получите chat_id или user_id черезWebhook/Long Polling API MAX.
Установите maxnotify.provider в значение maxbusiness.

Заполните настройки:

— maxnotify.max_token — токен бота;
— maxnotify.max_recipient_type — chat_id или user_id;
— maxnotify.max_recipient_ids — один или несколько ID через запятую;
— maxnotify.max_notify — уведомлять участников чата;
— maxnotify.max_disable_link_preview — отключить превью ссылок.

Официальный API принимает сообщения длиной до 4000 символов. Более длинные уведомления MaxNotify автоматически сокращает.

## Подключение rumaxbot.ru

1. Зарегистрируйтесь на rumaxbot.ru и подтвердите email.
2. Создайте канал.
3. Подключите MAX-бота к каналу по инструкции сервиса.
4. Создайте API-ключ канала.
5. Укажите ключ в настройке `maxnotify.api_key`.

API-ключ нельзя публиковать или добавлять в репозиторий.

## Шаблоны сообщений

После установки в категории элементов `MaxNotify` будут созданы чанки:

— maxNotifyOrderCreated — новый заказ в Markdown;
— maxNotifyOrderStatus — новый статус в Markdown;
— maxNotifyOrderCreatedHtml — новый заказ в HTML;
— maxNotifyOrderStatusHtml — новый статус в HTML;
— maxNotifyForm — заявка с формы в Markdown;
— maxNotifyFormHtml — заявка с формы в HTML.

Доступные плейсхолдеры: num, cost, receiver, phone, email,
address, comment, order_comment, products, delivery_name,
payment_name, status_name, manager_url, source, title, fields,
resource_id, resource_pagetitle, ip и другие поля заказа или формы.