Документация MACRO

Интеграция с сайтом

Для приема лидов с вашего сайта необходимо зарегистрировать его в CRM и настроить на сайте отправку лидов.

#1. Регистрация сайта в CRM

Для регистрации сайта в CRM откройте раздел Компания -> Интеграции и добавьте свой сайт:

Для отправки запроса вам понадобится имя домена и App_secret (Защищенный ключ) для подписывания запроса.

#

#2. Отправка запроса

Для добавления лида и выполнения других команд вам необходимо отправить POST-запрос по адресу:

Параметры запроса:

ПараметрОбязательныйПримерОписание
domainДа"вашсайт.рф"Домен, зарегистрированный в MacroCRM.
timeДа1234567890unix timestamp запроса.
tokenДа

md5(domain+time+app_secret)

пример на php:
$token = md5($domain . time() . $app_secret)

actionДа"buy"

buy - форма подачи заявки на покупку.

sell - форма подачи заявки на продажу.

callback - если передан номер телефона, то будет осуществлена попытка связать клиента со случайным менеджером колл-центра, находящимся "онлайн".

question - подача вопроса от посетителя сайта, вопрос будет добавлен к заметкам заявки. Обязательна передача вопроса в параметре message.

reserve - заявка на бронь, обязателен параметр id, при этом создаваемый лид будет связан с указанным объектом недвижимости.

askprice - после получения лида клиенту будет выслано письмо с презентацией объекта. Обязателен параметр id, при этом создаваемый лид будет связан с указанным объектом недвижимости.

meet - добавление задачи с типом «Встреча в офисе». Если у клиента отсутствуют заявки, то будет создана в том числе и заявка.

nameДаИванИмя клиента.
phoneДа*+7 (123) 456 78-90

Телефоны клиента массивом, либо через запятую.
*либо телефон, либо почта клиента должны быть заполнены.

emailДа*ivan@somedomain.tldПочта клиента, массивом либо через запятую.
tagsИпотека, Молодая семьяСтрока с тегами через запятую или массив тегов.
id123456

id объекта в CRM.

При подаче заявки сразу будет создан предварительный показ указанного объекта.

estate_buy_housesInterest

123456

int

array

messageДа, для action=question"Интересует информация о доме №7"

Комментарий к заявке.
Если используется action=meet, то **message **будет также добавлен в описание задачи.

filesПрикрепленные к запросу файлы

Массив файлов в формате jpg, jpeg, png, pdf, zip, rar. Для успешной передачи файлов, запрос должен быть отправлен с типом formData.

При передаче параметра файлы будут прикреплены к заявке.

channel_medium"Обратный звонок"Произвольная метка формы для точного учета источника лида.
utm

['utm_keyword'=>'новостройки самары',
'utm_source'=>'yandex',
'utm_medium'=>'cpc',
'utm_campaign'=>'kupit_kvartiru',
'utm_type'=>'context',
'utm_block'=>'premium',
'utm_position'=>'3',
'utm_campaign_id'=>'123456',
'utm_ad_id'=>'123456789',
'utm_phrase_id'=>'19876565432',
'ip'=>'1.2.3.4']

Массив UTM меток
cookie_base64base64_encode(json_encode($_COOKIE))Json формат массива Cookie посетителя, закодированный в формат MIME base64. Используется для передачи в том числе меток систем аналитики (Яндекс Метрика, GA, Roistat и пр.)
manager_idДа, для action=meet и для status_custom123456

id пользователя, который будет назначен менеджером заявки.
Если используется action=meet, то manager_id будет также назначен исполнителем задачи, но только в том случае, если у клиента нет заявок на других менеджерах. В противном случае задача будет назначена на менеджера существующей заявки.

meet_dateДа, только для action=meet01.01.2021Срок выполнения задачи. Используется только с action=meet
status_custom123ID кастомного подстатуса для статуса "Проверка". Используется только в паре с параметром manager_id.

is_allow_sms

is_allow_email

is_allow_call
is_allow_personal_data

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Да1234567890unix timestamp запроса
tokenДа

md5(domain+time+app_secret)

пример на php:
$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Да1234567890unix timestamp запроса
tokenДа

md5(domain+time+app_secret)

пример на php:
$token = md5($domain . time() . $app_secret)

typeДа"living"

living - объекты жилой недвижимости (квартиры, парковки, кладовки)

comm - объекты коммерческой недвижимости

last_modifiedНет1234567890

Запрос только записей с изменениями, произошедшими с указанного времени.
**Только при указании данного параметра в результирующих данных будут приходить записи с полем removed (запись снята с публикации)

activityНет"sell"

Фильтр по активности
sell - продажа
rent - аренда (только для КН)

withdealsНет0

1 - включать в список проданные объекты
0 - включать в список только объекты в подборе или резерве (если разрешено выгружать резервы в настройках компании)

separateНет0

**1 - **выгрузка только опубликованных объектов, отмеченных в точечной выгрузке
0 - выгрузка всех опубликованных объектов

idНет123456

id объекта в CRM
вернет данные только по указанному объекту

parent_idsНет123456

id дома в CRM
вернет данные только по объектам, входящим в этот дом

limit100

Количество записей в выборке
Возвращается это количество +1
последний элемент содержит только поле "last_record_id", ведущее на следующий объект в выборке

start_from

id объекта с которого начать выборку
(last_record_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 (выбор указанных акций)

Актуальный справочник экспортируемых атрибутов объектов недвижимостиПереход на внешний сайтhttps://api.macroserver.ru/docs/estate#/