Установка

После скачивания модуля, его установка производится штатными средствами CS-Cart на странице Панель администратора → Модули → Управление модулями → Загрузить и установить модуль (+).

Для версии CS-Cart более 4.13.1 Панель администратора → Модули → Управление модулями → Кнопка Шестеренка → Ручная установка

Нажимаем Загрузить, в появившемся окне выбираем файл модуля, далее Загрузить и установить

Интеграция обмена с сервисом Roistat напрямую из магазина CS-Cart

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

При создании, редактировании и изменении заказов, а так же их статусов или изменении данных пользователей происходит передача отформатированных данных сервису Roistat посредством обращения к его API (https://roistat.api-docs.io/v1/obshie-svedeniya)

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

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

1. Номер счётчика

Номер располагается в настройках проекта, пункт меню </>Код счетчика.

Номер копируется одной строкой. 

2. API ключ пользователя

Ключ находится в настройках профиля пользователя, пункт меню API.

Нажмите кнопку Показать и скопируйте API ключ.

3. Скопируйте номер проекта.

Номер проекта указан в шапке сервиса. 

4. Подключите в каталоге интеграций сервиса Roistat модуль RoistatAPI

На этом предварительная настройка сервиса завершена. Как только в систему попадут первые сделки и они будут обработаны (1-2 часа в зависимости от нагрузки на сервис Roistat) то раздел "Состояние проекта" примет соответствующий вид:

Станет возможным обновление данных аналитики без ожидания очереди на обработку.

Настройка модуля

Настройка модуля осуществляется в административной панели CS-Cart на странице "Управление модулями"

ШАГ 1. Необходимо заполнить все поля, на вкладке Параметры. 

После сохранения в настройках модуля ID счётчика, API ключа и номера проекта, модуль произведёт проверку подключения с сервисом Roistat и отобразит кнопку, позволяющую выгрузить статусы заказов и имеющиеся заказы в вашем магазине.

В случае наличия ошибок в данных, будет выведено соответствующее сообщение. 

ШАГ 2. Требуется настроить выгружаемые поля.

Система Roistat требует наличия 3-х обязательных полей для приёма заявок:
ID сделки, дата создания сделки, ID статуса сделки эти поля выгружаются автоматически и не требуют настройки со стороны пользователя.

Остальные поля вы можете выбрать для выгрузки на вкладке Экспортируемые поля.

Общие поля:

Название сделки - человекочитаемое название сделки вида "Заказ №".
Код roistat - номер визита.
Сумма заказа - сумма сделки; используется в показателе "Выручка" в Roistat.
Client id - ID клиента в CS-Cart.
Себестоимость - себестоимость сделки (для работы необходим модуль от RetailFactory Затраты и прибыль магазина).

Дополнительные поля:

Витрина - название магазина в котором был сделан заказ.

Загрузка данных

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

В первую очередь будут созданы статусы заказов из Вашего магазина и помещены в категорию "В работе".

Внимание!

Если в процессе работы с модулем кнопка "Выгрузить всё в Roistat" будет нажата вновь, то все статусы заказов будут опять переведены в категорию "В работе".

После выгрузки статусов заказов, будут выгружены все ранее созданные заказы, за исключением  заказов со статусом "Незавершенный". Обращаем внимание, что заказы с данным статусом не обрабатываются и не выгружаются в Roistat никогда!

Интеграция обмена с сервисом Roistat через сервис МойСклад

Внимание!

Если Вы осуществляете настройку модуля для интеграции с Roistat через МойСклад, то нет необходимости в заполнении полей "Ваш ключ API" и "Номер проекта". В таком случае основная настройка ведётся на стороне сервисов Roistat и МойСклад.

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

1. После создания заказов, мы добавляем в созданное при установки модуля поле ms_roistat(таблица ?:orders) в базе данных значение из COOKIE roistat_visit.
2. При синхронизации с Моим Складом, добавляем в xml файл поле roistat (код roistat_visit) и showcase (название витрины магазина).
3. Roistat с Моим Складом настраивается и синхронизируется отдельно от модуля.

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

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

Номер счётчика

Номер располагается в настройках проекта, пункт меню </>Код счетчика.

Номер копируется одной строкой.

2. Далее необходимо вставить код счётчика в соответствующее поле настроек модуля.

3. Теперь мы должны изменить код стороннего модуля rus_exim_1c.

   а. Ручное изменение кода.

В файле /app/addons/rus_exim_1c/Tygh/Commerceml/RusEximCommerceml.php добавим код fn_set_hook('rus_exim_1c_order_data', $order_data, $order_xml);  в функцию public function dataOrderToFile($xml, $order_data, $lang_code).
Пример добавленного кода:

public function dataOrderToFile($xml, $order_data, $lang_code)
    {
        $export_statuses = $this->s_commerceml['exim_1c_export_statuses'];
        $cml = $this->cml;

        $order_xml = $this->getOrderDataForXml($order_data, $cml);

        // new hook for module ms_roistat
        fn_set_hook('rus_exim_1c_order_data', $order_data, $order_xml);
        
        if (empty($order_data['firstname'])) {
            unset($order_data['firstname']);
......

   б. Автоматическое добавление кода.
Автоматизировать процесс добавления кода в сторонний модуль возможно установив наш модуль ms_addon_fixer и применив в нём фикс Добавление хука для Roistat.

На этом настройка модуля завершена и необходимо настроить сервис МойСклад.

Настройка сервиса МойСклад

В своём аккаунте сервиса необходимо перейти на вкладку Продажи → Заказы покупателей и нажать кнопку Настройка (шестеренка).

В появившемся окне мы добавляем два поля, типа строка, roistat и showcase.

Далее настройка соединения происходит согласно официальной инструкции https://www.cs-cart.ru/docs/4.11.x/user_guide/addons/commerceml/moy_sklad/.

Cинхронизация заказов происходит по настроенному расписанию системы МойСклад.

v2.0.4  от 11.08.2021

[+] Добавлена интеграция с модулем [RetailFactory] Затраты и прибыль магазина.
[+] Добавлено поле себестоимости от зависимого модуля.

v2.0.3 от 12.11.2019

[!] Исправлены ошибки выгрузки.

v2.0.2 от 10.10.2019

[!] Исправлены ошибки выгрузки.

v2.0.1 от 03.10.2019

[+] Добавлена прямая интеграция с RoistatAPI.
[+] Ручная выгрузка Статусов заказов, клиентов и заказов.
[+] Автоматическая выгрузка Заказов и Клиентов при добавлении, обновлении или смене статуса заказа.
[+] Организованно логирование запросов к RoistatAPI в файл app/addons/ms_roistat/log.txt.

v1.5.1 от 10.09.2019

[+] Добавлено поле витрины для выгрузки в МойСклад "showcase".
[-] Удалён смарт-хук order_status.post.
[+] Добавлен смарт-хук details_sidebar.pre.tpl.