Для приема лидов с вашего сайта необходимо зарегистрировать его в CRM и настроить на сайте отправку лидов.
#1. Регистрация сайта в CRM
Для регистрации сайта в CRM откройте раздел Компания -> Интеграции и добавьте свой сайт:
Для отправки запроса вам понадобится имя домена и App_secret (Защищенный ключ) для подписывания запроса.
#
#2. Отправка запроса
Для добавления лида и выполнения других команд вам необходимо отправить POST-запрос по адресу:
- https://api.macroserver.ru/estate/request/Переход на внешний сайтhttps://api.macroserver.ru/estate/request/, если система MACRO установлена на macroserver.ru
- https://api.macro.sbercrm.com/estate/request/Переход на внешний сайтhttps://api.macro.sbercrm.com/estate/request/ если система MACRO установлена на macro.sbercrm.com
Параметры запроса:
| Параметр | Обязательный | Пример | Описание |
|---|---|---|---|
| domain | Да | "вашсайт.рф" | Домен, зарегистрированный в MacroCRM. |
| time | Да | 1234567890 | unix timestamp запроса. |
| token | Да | md5(domain+time+app_secret) | |
| action | Да | "buy" | buy - форма подачи заявки на покупку. askprice - после получения лида клиенту будет выслано письмо с презентацией объекта. Обязателен параметр id, при этом создаваемый лид будет связан с указанным объектом недвижимости. |
| name | Да | Иван | Имя клиента. |
| phone | Да* | +7 (123) 456 78-90 | Телефоны клиента массивом, либо через запятую. |
| Да* | ivan@somedomain.tld | Почта клиента, массивом либо через запятую. | |
| tags | Ипотека, Молодая семья | Строка с тегами через запятую или массив тегов. | |
| id | 123456 | id объекта в CRM. | |
| estate_buy_housesInterest | 123456 | array | |
| message | Да, для action=question | "Интересует информация о доме №7" | Комментарий к заявке. |
| files | Прикрепленные к запросу файлы | Массив файлов в формате jpg, jpeg, png, pdf, zip, rar. Для успешной передачи файлов, запрос должен быть отправлен с типом formData. | |
| channel_medium | "Обратный звонок" | Произвольная метка формы для точного учета источника лида. | |
| utm | ['utm_keyword'=>'новостройки самары', | Массив UTM меток | |
| cookie_base64 | base64_encode(json_encode($_COOKIE)) | Json формат массива Cookie посетителя, закодированный в формат MIME base64. Используется для передачи в том числе меток систем аналитики (Яндекс Метрика, GA, Roistat и пр.) | |
| manager_id | Да, для action=meet и для status_custom | 123456 | id пользователя, который будет назначен менеджером заявки. |
| meet_date | Да, только для action=meet | 01.01.2021 | Срок выполнения задачи. Используется только с action=meet |
| status_custom | 123 | ID кастомного подстатуса для статуса "Проверка". Используется только в паре с параметром manager_id. | |
is_allow_sms is_allow_email is_allow_call | 1 | Согласие на способ коммуникации и обработку перс данных, принимает значение 1 (Да) или 0 (Нет) |
**Результат запроса возвращается в **JSON-формате
В случае удачного создания возвращается ID созданного объявления.
Пример результата:
['success'=>true,'estate_id'=>123456]
Пример с ошибкой:
['error'=>true,'message'=>'Ошибка аутентификации']
#
#3. Получение списка жилых комплексов
Для получения списка объектов вам необходимо отправить GET-запрос по адресу:
https://api.macroserver.ru/estate/group/getComplexes/
Параметры запроса:
| Параметр | Обяза-тельный | Пример | Описание |
|---|---|---|---|
| domain | Да | "вашсайт.рф" | Домен, зарегистрированный в MacroCRM |
| time | Да | 1234567890 | unix timestamp запроса |
| token | Да | md5(domain+time+app_secret) |
Пример на php:
$token = md5($domain . time() . $app_secret)
Результат запроса возвращается в JSON-формате.
Пример результата:
{
"complexes" : [
{
"id" : 1234,
"name" : "ЖК «Звезда сибири»",
"houses" : [
{
"id" : 123456,
"name" : "ЖК «Звезда сибири», Оранжевый дом",
"address" : "Россия, Новосибирск, ул.Ленина, д.2/1"
},
...
]
},
...
]
}
#
#4. Получение списка объектов
Для получения списка объектов вам необходимо отправить GET-запрос по адресу:
https://api.macroserver.ru/estate/get/
Параметры запроса:
| Параметр | Обяза-тельный | Пример | Описание |
|---|---|---|---|
| domain | Да | "вашсайт.рф" | Домен, зарегистрированный в MacroCRM |
| time | Да | 1234567890 | unix timestamp запроса |
| token | Да | md5(domain+time+app_secret) | |
| type | Да | "living" | living - объекты жилой недвижимости (квартиры, парковки, кладовки) |
| last_modified | Нет | 1234567890 | Запрос только записей с изменениями, произошедшими с указанного времени. |
| activity | Нет | "sell" | Фильтр по активности |
| withdeals | Нет | 0 | 1 - включать в список проданные объекты |
| separate | Нет | 0 | **1 - **выгрузка только опубликованных объектов, отмеченных в точечной выгрузке |
| id | Нет | 123456 | id объекта в CRM |
| parent_ids | Нет | 123456 | id дома в CRM |
| limit | 100 | Количество записей в выборке | |
| start_from | id объекта с которого начать выборку |
Результат запроса возвращается в JSON-формате.
Пример результата:
[{"id":"123456","type":"living","activity":"sell",....},
{"id":"123457",...},
{"last_record_id":"123499"}]
Пример ошибки:
['error'=>true,'message'=>'Ошибка аутентификации']
#5. Вывод акций по API
MacroCRM передает все данные о текущих акциях через их ID по API на сайт.
Для начала нужно выполнить полную выгрузку акций — ID Акции — на сайте, а затем выгрузить объекты, уже содержащие ID Акций. Далее на сайте необходимо настроить сопоставление ID Объекта с ID Акции и отобразить нужную информацию по акциям.
В метод /estate/get/ для каждого объекта (квартиры, кладовки и т.д.) добавлен параметр
promos (/estate/getPromos/), в который передаются ID всех акций, доступных для данного объекта, в следующем формате:
- id: ID акции в MacroCRM
- title: Название акции
- description: Текстовое описание акции
- date_from: Дата начала акции
- date_to: Дата окончания акции
- rule: Правило изменения цены (Изменение цены за 1 м² по прайсу, Изменение стоимости по прайсу, Без изменения цены)
- type: Тип изменения цены (% или рубли)
- value: Значение изменения цены
- direction: Направление изменения цены (Наценка или Скидка)
- rounding: Округление (Не округлять, Округлять до целых в большую сторону, Округлять до целых в меньшую сторону)
- parent_id: Дома, к которым привязана акция
- category: Категории, к которым привязана акция
- rooms: Комнатность, для которой доступна акция (1, 2, 3, …)
- studia: Признак студий для комнатности (all, yes, no)
Метод поддерживает фильтрацию:
- по complex_id (выбор акций, доступных для объектов, привязанных к указанным группам домов)
- по parent_id (выбор акций, доступных для объектов, привязанных к указанным домам)
- по estate_id (выбор акций, доступных для указанных объектов)
- по promo_id (выбор указанных акций)