 |
retailCRM – специализированная облачная CRM-система для интернет-магазинов, которая помогает управлять заказами, клиентами и всеми коммуникациями в едином окне.
API retailCRM позволяет получать сведения по заказам, компаниям и другие данные. В этой инструкции рассматривается подключение к retailCRM и доступный функционал нашего сервиса по выгрузке данных.
Для того чтобы настроить выгрузку данных из retailCRM, в первую очередь необходимо создать ключ для доступа по API.
Для этого перейдите в раздел «Администрирование» (1), на открывшейся странице в верхнем меню выберите «Интеграция» (2), после чего выберите «Ключи доступа к API» (3) и нажмите на кнопку «Добавить» (4).
Вводим «Комментарий» (1), допустим «mybi», выбираем необходимый магазин, доступ к которому необходимо предоставить (2), и нажимаем кнопку «Сохранить» (3).
Вы также можете ограничить права, которые будут предоставлены приложению, использующему этот ключ, но в случае, если прав будет недостаточно, то сервис mybi connect не сможет выгрузить необходимые данные. На данный момент необходимы следующие разрешения:
- Заказы, /api/orders
- Справочники, /api/reference/order-methods
- Справочники, /api/reference/order-types
- Справочники, /api/reference/statuses
- Справочники, /api/reference/sites
- Пользователи, /api/users
но со временем они могут измениться.
Скопируйте созданный ключ
Следующая часть настроек выполняется в сервисе mybi connect. Для того чтобы добавить новый источник данных необходимо в левом боковом меню сервиса mybi connect выбрать пункт “Источники данных“, нажать на кнопку “Добавить новый+”, после чего перейти в раздел “CRM-СИСТЕМЫ” и выбрать источник retailCRM, нажав на кнопку “подключить”:
Вводим название источника (произвольно, с таким названием источник будет отображаться в списке), имя поддомена (если адрес для входа в CRM example.retailcrm.ru, то поддоменом в данном случае является просто example) и ранее скопированный ключ:
После ввода всех данных необходимо завершить настройку источника, нажав на кнопку “Продолжить”.
Базовая выгрузка
После завершения подключения в таблице “Источники” появится новый источник, с указанным ранее названием. Если вы используете Триал, то автоматически запустится выгрузка данных за 2 последних дня и вы можете сразу перейти к просмотру данных в БД. Далее для запуска исторической загрузки данных за нужный период выберите в колонке “Действия” в строке добавленного источника пункт меню “Загрузить”:
Обратите внимание, что период доступной исторической загрузки зависит от выбранных вами параметров тарифа, а для триального периода составляет 1 месяц.
По завершению загрузки в базе данных появятся сведения по пользователям и событиям в специально спроектированном нами виде, наиболее удобном для дальнейшего анализа:
Более детально ознакомиться со структурой выгрузки вы можете здесь.
Если вы не нуждаетесь в каких-то данных, можно воспользоваться функционалом по выбору необходимых таблиц и отметить только нужные, в которые будут загружаться данные в процессе базовой выгрузки:
Это позволит вам как ограничить набор данных, так и в какой-то мере сэкономить количество расходуемых на выгрузку строк.
Кроме возможности выбора таблиц, в базовой выгрузке также существует функционал фильтрации, позволяющий ограничить данные, загружаемые в таблицы. Вот пример использования фильтра:
Этот фильтр позволяет не загружать отмененные заказы.
Пользовательская выгрузка
Пользовательская выгрузка позволяет организовать загрузку произвольного набора полей с последующем автоматическим обновлением по текущий период. Необходимым условием создания выгрузки является наличие настроенного источника. Для ее создания необходимо перейти в раздел “Планировщик заданий“, нажать на кнопку “Добавить новое+” и выбрать из списка “Выгрузка отчетов из RetailCRM”. Далее вы попадете на форму с параметрами выгрузки:
В первой строке указываем произвольное название задания (длиной не более 64-х символов), выбрать аккаунт RetailCRM и тип отчета. Вам будут предложены следующие варианты отчетов:
- информация о заказе;
- позиции в заказе;
- история изменений заказов.
После этого необходимо сформировать список необходимых полей и указать параметры обновления данных. По умолчанию загружаемые данные сохраняются в таблицу retailcrm_reports в формате JSON.
Если воспользоваться опцией “Зафиксировать структуру”, то в этом случае данные отчета будут выгружаться в отдельную таблицу в развернутом виде. Дополнительно в поле “Описание таблиц” можно добавить специальное правило, описывающие каким образом полученные сведения должны обрабатываться mybi connect. Это даст возможность пользователю сохранять данные в удобном виде и в указанных таблицах. Для завершения настройки пользовательской выгрузки необходимо нажать на кнопку “Продолжить”.
Добавив отчет в список заданий, его можно запустить для загрузки данных, это можно сделать отобразив меню “Выбрать” в колонке “Действия” напротив созданного отчета и выбрав пункт меню “Выполнить”:
После указания периода загрузки данные будут загружены в хранилище.
Сверка загруженных данных
Задание “Проверка загруженных данных” позволяет выявить наличие расхождений между имеющимися сведениями в базе данных и сервисе-источнике (в данном случае retailCRM), а также актуализировать состояние загруженных данных за прошлые периоды в случае выявления расхождений.
При выявлении отклонений используются следующий набор параметров и показателей для сравнения:
- код статуса заказа;
- код типа доставки;
- количество заказов;
- общая сумма;
- стоимость закупки;
- сумма по товарам.
Результаты проверки загруженных данных вы можете найти в журнале событий (колонка “Действия” -> Журнал событий -> Сверка):
Удаление устаревших данных
Учитывая, что у любых данных есть свойство накапливаться со временем, а объем хранилища в нашем сервисе ограничен в зависимости от используемого тарифного плана, в некоторых случаях можно воспользоваться дополнительным заданием “Удаление устаревших данных“. Это задание позволяет удалять хранящиеся данные из хранилища, которые были получены более чем N дней назад, где N – это количество дней, указанное в настройках задания. К примеру:
Такое задание будет удалять данные старше 90 дней.
Мы будем рады вашим вопросам и рациональным комментариям относительно функционала сервиса в чате нашего телеграм-канала @mybi connect