 |
YCLIENTS – система для автоматизации и управления бизнесом в сфере услуг.
API YCLIENTS позволяет получать сведения по клиентам, записям, услугам, компаниям и другие данные. В этой инструкции рассматривается подключение к YCLIENTS и доступный функционал нашего сервиса по выгрузке данных.
Для того чтобы добавить новый источник данных необходимо в левом боковом меню сервиса mybi connect выбрать пункт “Источники данных“, нажать на кнопку “Добавить новый+”, после чего перейти в раздел “CRM-СИСТЕМЫ” и выбрать источник YCLIENTS, нажав на кнопку “подключить”:
В открывшейся форме необходимо ввести название нового источника. Поле “Название источника” может быть любым и необходимо для того, чтобы вы могли однозначно идентифицировать этот источник среди других.
После нажатия на кнопку “Продолжить” в следующей форме необходимо ввести логин и пароль пользователя YCLIENTS:
В качестве логина может быть использован номер телефона пользователя в формате 79161234567 или его Email. Нажмите “Продолжить”. Возможность выгрузки данных зависит от прав доступа пользователя. Если авторизационные данные верны, в следующей форме выберите компанию, для которой необходимо выгружать данные. После ввода всех данных необходимо завершить настройку источника, нажав на кнопку “Продолжить”.
Базовая выгрузка
После завершения подключения в таблице “Источники” появится новый источник, с указанным ранее названием. Если вы используете Триал, то автоматически запустится выгрузка данных за 2 последних дня и вы можете сразу перейти к просмотру данных в БД. Далее для запуска исторической загрузки данных за нужный период выберите в колонке “Действия” в строке добавленного источника пункт меню “Загрузить”:
Обратите внимание, что период доступной исторической загрузки зависит от выбранных вами параметров тарифа, а для триального периода составляет 1 месяц.
По завершению загрузки в базе данных появятся сведения по пользователям и событиям в специально спроектированном нами виде, наиболее удобном для дальнейшего анализа:
Более детально ознакомиться со структурой выгрузки вы можете здесь.
Если вы не нуждаетесь в каких-то данных, можно воспользоваться функционалом по выбору необходимых таблиц и отметить только нужные, в которые будут загружаться данные в процессе базовой выгрузки:
Это позволит вам как ограничить набор данных, так и в какой-то мере сэкономить количество расходуемых на выгрузку строк.
Кроме возможности выбора таблиц, в базовой выгрузке также существует функционал фильтрации, позволяющий ограничить данные, загружаемые в те или иные таблицы. Вот пример использования фильтра:
Этот фильтр позволяет выгружать в БД только данные по определенной категории услуг.
Использование вебхука
YCLIENTS также предоставляет возможность передачи данных с помощью вебхуков. Это означает, что сервис самостоятельно передает данные при помощи HTTP-запроса. Такие запросы mybi connect умеет получать и записывать в базу данных для дальнейшего использования.
Для настройки получения данных с помощью вебхуков в сервисе mybi connect необходимо скопировать URL, из настроек созданного выше источника данных:
(Источники данных -> колонка “Действия” -> Настройки источника). Далее следует перейти в интерфейс YCLIENTS, в левом боковом меню сервиса выбрать пункт “Настройки” (1) и нажать “WebHook” (2)
Далее в открывшейся форме выбрать “Отправлять” в опции “Отправлять хуки” и указать адрес, на который отправлять уведомления, скопированный из настроек источника:
Ниже в списке событий, при которых будет осуществляться отправка данных, выберите “Событие по записям”. Завершить настройку вебхуков необходимо нажав на кнопку “Сохранить” в нижней части формы.
На этом настройка YCLIENTS закончена. В дальнейшем сведения по событиям будут автоматически загружаться в базу данных, доступ к которой вы можете найти в разделе “Хранилище данных“.
Пользовательская выгрузка
Пользовательская выгрузка позволяет организовать загрузку произвольного набора полей с последующем автоматическим обновлением по текущий период. Необходимым условием создания выгрузки является наличие настроенного источника. Для ее создания необходимо перейти в раздел “Планировщик заданий“, нажать на кнопку “Добавить новое+” и выбрать из списка “Выгрузка отчетов из YCLIENTS”. Далее вы попадете на форму с параметрами выгрузки:
В первой строке указываем произвольное название задания (длиной не более 64-х символов), выбрать аккаунт YCLIENTS и тип отчета. Вам будут предложены следующие варианты отчетов:
- документы;
- расходники по записям;
- товарные транзакции;
- финансовые транзакции;
- категории записи;
- услуги.
После этого необходимо сформировать список необходимых полей и указать параметры обновления данных. По умолчанию загружаемые данные сохраняются в таблицу yclients_reports в формате JSON.
Если воспользоваться опцией “Зафиксировать структуру”, то в этом случае данные отчета будут выгружаться в отдельную таблицу в развернутом виде. Дополнительно в поле “Описание таблиц” можно добавить специальное правило, описывающие каким образом полученные сведения должны обрабатываться mybi connect. Это даст возможность пользователю сохранять данные в удобном виде и в указанных таблицах. Для завершения настройки пользовательской выгрузки необходимо нажать на кнопку “Продолжить”.
Добавив отчет в список заданий, его можно запустить для загрузки данных, это можно сделать отобразив меню “Выбрать” в колонке “Действия” напротив созданного отчета и выбрав пункт меню “Выполнить”:
После указания периода загрузки данные будут загружены в хранилище.
Сверка загруженных данных
Задание “Проверка загруженных данных” позволяет выявить наличие расхождений между имеющимися сведениями в базе данных и сервисе-источнике (в данном случае YCLIENTS), а также актуализировать состояние загруженных данных за прошлые периоды в случае выявления расхождений.
При выявлении отклонений используются следующий набор параметров и показателей для сравнения:
- итоговая стоимость;
- количество;
- начальная стоимость;
- цена за единицу;
- статус.
Результаты проверки загруженных данных вы можете найти в журнале событий (колонка “Действия” -> Журнал событий -> Сверка):
Удаление устаревших данных
Учитывая, что у любых данных есть свойство накапливаться со временем, а объем хранилища в нашем сервисе ограничен в зависимости от используемого тарифного плана, в некоторых случаях можно воспользоваться дополнительным заданием “Удаление устаревших данных“. Это задание позволяет удалять хранящиеся данные из хранилища, которые были получены более чем N дней назад, где N – это количество дней, указанное в настройках задания. К примеру:
Такое задание будет удалять данные старше 90 дней.
Мы будем рады вашим вопросам и рациональным комментариям относительно функционала сервиса в чате нашего телеграм-канала @mybi connect