Как работает интеграция¶
Интеграция осуществляется через механизм «Интеграция со своей CRM».
При оформлении заявки на сайте автоматически создается новая сделка в CRM, в которую передается номер визита из куки браузера roistat_visit в дополнительное поле с именем roistat. Если менеджер принимает заказ по телефону, он может спросить промокод (настраивается отдельно)и ввести этот код в поле roistat.
Примерно раз в час осуществляется загрузка измененных за последние несколько дней сделок из СRM системы в аналитику Roistat.
Требования к API методам CRM системы¶
Для того, чтобы взаимодействовать с системой аналитики Roistat, CRM система должна поддерживать следующие методы:
Метод создания лидов (сделок)¶
Заявки с сайта изначально должны автоматически фиксироваться в СRM системе. Должно поддерживаться создание доп. полей и передача в них информации. В общем виде метод должен поддерживать передачу следующих параметров:
-
name
-
phone
-
email
-
comment
-
roistat_visit
-
и т.д.
Метод получения списка лидов (сделок)¶
Для того, чтобы выгрузить измененные заявки в аналитику необходимо обращаться к методу, который будет отдавать список лидов (сделок). В общем виде метод должен возвращать следующую информацию по каждому лиду (сделки):
-
lead_id
-
comment(если есть)
-
price(если есть)
-
cost(если есть)
-
status_id
-
manager_id
-
client_id(если есть)
-
date_update
-
roistat_visit
-
и другие поля доступные у лида(если есть)
*метод должен поддерживать фильтр по полю date_update
Метод получения списка статусов лидов (сделок)¶
Пользователь указывает соответствие статусов CRM системы и групп статусов в Roistat: в работе, оплаченные, отмененные. В общем виде метод должен возвращать следующую информацию по статусам CRM системы:
-
status_id
-
status_name
Метод создание клиента и метод поиска клиента¶
При создании сделки как правило создается клиент/контакт. Для работы с клиентами/контактами нужен метод создание клиента и метод поиска клиента. В рамках интеграции отправляется запрос на поиск клиента по заданным параметрам, которые клиент указал на сайте. Если клиент не существуют, то выполняем метод «Создание клиента».
В общем виде метод поиска клиентов должен отдавать список клиентов по переданным контактным данным.
Метод создания клиента в общем виде должен поддерживать следующие параметры:
-
name
-
phone
-
email
-
и другие поля доступные у клиента(если есть)
Метод выгрузки списка клиентов¶
Для того чтобы в Roistat был доступен раздел «Управление клиентами» необходим метод для выгрузки списка клиентов из CRM системы. В общем виде метод должен отдавать следующие данные:
-
client_id
-
name
-
phone
-
email
-
и другие поля доступные у клиента(если есть)