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

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

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

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

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

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

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

https://api.macroserver.ru/estate/request/, если система MACRO установлена на macroserver.ru
https://api.macro.sbercrm.com/estate/request/ если система MACRO установлена на macro.sbercrm.com

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

Результат запроса возвращается в JSON формате. В случае удачного создания возвращается ID созданного объявления.

Пример результата:

['success'=>true,'estate_id'=>123456]Пример с ошибкой:

['error'=>true,'message'=>'Ошибка аутентификации']

3. Получение списка жилых комплексов

Для получения списка объектов вам необходимо отправить GET запрос по адресу:

https://api.macroserver.ru/estate/group/getComplexes/Параметры запроса

пример на 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/Параметры запроса

Результат запроса возвращается в 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 (выбор указанных акций)

Актуальный справочник экспортируемых атрибутов объектов недвижимости

Last updated 5 days ago

Параметр

Обяза-тельный

Пример

Описание

Параметр

Обяза-тельный

Пример

Описание

{ "complexes" : [ { "id" : 1234, "name" : "ЖК «Звезда сибири»", "houses" : [ { "id" : 123456, "name" : "ЖК «Звезда сибири», Оранжевый дом", "address" : "Россия, Новосибирск, ул.Ленина, д.2/1" }, ... ] }, ... ] }

Параметр

Обяза-тельный

Пример

Описание