modRetailCRM
Описание
Компонент для интеграции популярного сервиса RetailCRM с MODX.
Компонент в основном заточен под популярный интернет-магазин miniShop2, но может работать и без него в ручном режиме, поддерживая весь функционал заложенный в API RetailCRM.
Состав компонента
- Плагин, отслеживающий определенные события
- Ряд системных настроек
- Сниппет icml, формирующий базовую выгрузку для каталога RetailCRM
Что умеет modRetailCRM из коробки
- Отслеживать регистрацию новых пользователей (в том числе и скрытую регистрацию при создании заказа miniShop2) и создавать пользователей в RetailCRM
- Отслеживать создание новых заказов miniShop2 и передавать данных о заказах в RetailCRM
- Отслеживать изменение статусов заказов в интернет-магазине, и передавать эти изменения в RetailCRM, меняя статус заказа и там.
- Отслеживать изменения статусов заказов в RetailCRM и менять статусы этих заказов в интернет-магазине (Требуется дополнительная настройка на стороне RetailCRM)
- Работать с формами, отправляя необходимые данные (Требуется подготовка и написание сниппета)
Какие данные о пользователях передаются в RetailCRM
- Номер телефона
- Имя
- Идентификационный номер пользователя в MODX
Какие данные о заказе передаются в RetailCRM
- Номер заказа
- Перечень товаров в заказе, включая цену, наименование, количество, идентификатор товара (для связи с каталогом RetailCRM)
- Модификации товара на основе компонента msOptionsPrice2 и опции товаров
- Стоимость и способ доставки
- Способ оплаты
- Скидка сформированная компонентом msPromoCode
- Адрес доставки
- Общий вес заказа
Что отслеживает и делает плагин
- Событие OnUserSave - Регистрация новых пользователей. Данные о новых пользователях передаются в RetailCRM
- Событие msOnCreateOrder - Новые заказы. Данные передаются в RetailCRM
- Событие msOnChangeOrderStatus - Изменение статуса заказа. Данные об обновленном заказе передаются в RetailCRM
- Событие OnMODXInit - Добавление новых полей к способам Оплаты и Доставки, к статусу Заказа
- Событие msOnManagerCustomCssJs - Добавление новых полей к способам Оплаты и Доставки, к статусу Заказа
- Событие OnHandleRequest - Отлавливает данные из RetailCRM, переданные при помощи триггеров и применяет к соответствующим объектам на сайте (Например меняет статус заказа)
Системные настройки modRetailCRM
| Ключ | Описание |
|---|---|
| modretailcrm_apiKey | Ключ API - получить его можно в RetailCRM (Администрирование / Интеграция / Ключи доступа к API) |
| modretailcrm_siteCode | Символьный код сайта - получить его можно в RetailCRM (Администрирование / Магазины / Ваш магазин) |
| modretailcrm_url | URL адрес вашей CRM. Его можно взять прямо из адресной строки |
| modretailcrm_log | Логирование всех запросов. Необходимо для отладки |
| modretailcrm_sync_statuses | Перечень статусов заказов, необходимый для синхронизации статусов. Через запятую перечисляем все статусы, которые мы хотели бы отслеживать. Например 2, 4 (Оплачен, Выполнен). |
| modretailcrm_custom_customers_class | Дает возможность подключить собственный модуль управления клиентами |
| modretailcrm_custom_orders_class | Дает возможность подключить собственный модуль управления заказами |
| modretailcrm_allow_msoptionsprice | Сообщает об использовании компонента msOptionsPrice2 |
Предварительная настройка
Естественно у вас должен быть аккаунт в RetailCRM.
В системных настройках сайта (раздел modretailcrm) Вам нужно обязательно указать
- API ключ.
- адрес вашей CRM.
- символьный код сайта.
Доставка. Для передачи способов доставки при заказе нужно указать их символьные коды. Идем в настройки miniShop2 - открываем по очереди все активные способы доставки - в окне редактирования должно появиться новое поле Символьный код RetailCRM
Записываем туда соответствующий символьный код из справочника доставок RetailCRM. Сохраняем.
Проделываем то же самое со способами оплаты. Справочник типов оплаты можно найти в разделе Администрирование/Справочники RetailCRM
Проделываем то же самое со статусами заказа. Справочник статусов заказов можно найти в разделе Администрирование/Статусы RetailCRM
После этого рекомендуется настроить выгрузку товаров в каталог RetailCRM, Выгрузку существующих пользователей и заказов. По каждому из пунктов есть отдельный раздел документации. Это не обязательное условие для работы, но так вы получите более качественные отчеты и аналитику.
