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

Для приема лидов с Вашего сайта необходимо зарегистрировать его в 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

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

Параметр Обяза-тельный Пример Описание
domain Да "вашсайт.рф" Домен, зарегистрированный в MacroCRM.
time Да 1234567890 unix 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   Ипотека, Молодая семья

Строка с тегами через запятую или массив тегов.
id   123456

id объекта в CRM.

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

123456

int|array

id дома в CRM или простой массив с id домов.

При передаче параметра заявке в CRM будет присвоен интерес к указанным домам.
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_base64   
base64_encode(json_encode($_COOKIE))
 Json формат массива Cookie посетителя, закодированный в формат MIME base64. Используется для передачи в том числе меток систем аналитики (Яндекс Метрика, GA, Roistat и пр.)
manager_id Да, для action=meet и для status_custom 123456

id пользователя, который будет назначен менеджером заявки.
Если используется action=meet, то manager_id будет также назначен исполнителем задачи, но только в том случае, если у клиента нет заявок на других менеджерах. В противном случае задача будет назначена на менеджера существующей заявки.
meet_date Да, только для action=meet 01.01.2021 Срок выполнения задачи. Используется только с action=meet
status_custom   123 ID кастомного подстатуса для статуса "Проверка". Используется только в паре с параметром manager_id.

Результат запроса возвращается в 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)

пример на 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
вернет данные только по объектам, входящим в этот дом
limit   100 Количество записей в выборке
Возвращается это количество +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'=>'Ошибка аутентификации']

 Экспортируемые атрибуты объектов недвижимости

Атрибут Описание Тип данных
geo_country Страна int
geo_country_human Страна (справочное) varchar
geo_region Область int
geo_region_human Область (справочное) varchar
geo_city Город int
geo_city_human Город (справочное) varchar
geo_village Пригород int
geo_village_human Пригород (справочное) varchar
geo_district Район int
geo_district_human Район (справочное) varchar
geo_district_adm Административный район int
geo_district_adm_human Административный район (справочное) varchar
geo_district_set Районы города int
geo_district_set_human Районы города (справочное) varchar
geo_districtloc Свое название района varchar
geo_district_direction Направление int
geo_district_direction_human Направление (справочное) varchar
geo_region_place Населенный пункт int
geo_region_place_human Населенный пункт (справочное) varchar
geo_region_village Название поселка int
geo_region_village_human Название поселка (справочное) varchar
geo_complex Жилой комплекс int
geo_complex_human Жилой комплекс (справочное) varchar
geo_complex_set Жилые комплексы int
geo_complex_set_human Жилые комплексы (справочное) varchar
geo_street Улица int
geo_street_human Улица (справочное) varchar
geo_house № дома varchar
geo_house_human № дома (справочное) varchar
geo_house_construct Строй.номер bool
geo_building Строение varchar
geo_korpus Корпус varchar
geo_block Блок-секции varchar
geo_house_section Секция varchar
geo_house_entrance Подъезд int
geo_house_entrance_human Подъезд (справочное) varchar
geo_flatnum № квартиры/объекта varchar
geo_coords ГеоКоординаты varchar
geo_microdistrict Микрорайон varchar
geo_quarter Квартал varchar
geo_group Гр. зданий varchar
geo_house_constrNum Технич. номер объекта varchar
geo_metro Станция метро int
geo_metro_human Станция метро (справочное) varchar
geo_metro_set Станции метро int
geo_metro_set_human Станции метро (справочное) varchar
geo_metroDistance Расстояние до метро int
geo_metroDistance_human Расстояние до метро (справочное) varchar
geo_metroTimeOnTransport Время до метро в минутах на транспорте int
geo_metroTimeOnTransport_human Время до метро в минутах на транспорте (справочное) varchar
geo_metroTimeOnFoot Время до метро в минутах пешком int
geo_metroTimeOnFoot_human Время до метро в минутах пешком (справочное) varchar
geo_metroTransfer Как добраться до метро varchar
geo_centerDistance Расстояние до центра города decimal
geo_centerDistance_human Расстояние до центра города (справочное) varchar
geo_airportDistance Расстояние до аэропорта decimal
geo_airportDistance_human Расстояние до аэропорта (справочное) varchar
geo_mkadDistance Удаленность от МКАД decimal
geo_mkadDistance_human Удаленность от МКАД (справочное) varchar
geo_nearestAirportName Название ближайшего аэропорта varchar
geo_orientirs Ориентиры объекта varchar
geo_addressCustom Произвольный адрес varchar
estate_activity Активность varchar
estate_activityPlus Активность+ varchar
estate_ceilingHeight Высота потолка decimal
estate_ceilingHeight_human Высота потолка (справочное) varchar
estate_area Площадь decimal
estate_area_human Площадь (справочное) varchar
estate_area_range Площадь decimal
estate_area_range_human Площадь (справочное) varchar
estate_land_area Площадь прилегающ. зем. уч. decimal
estate_land_area_human Площадь прилегающ. зем. уч. (справочное) varchar
estate_land_characteristic Характеристика земельного участка int
estate_land_characteristic_human Характеристика земельного участка (справочное) varchar
estate_construction_stage Стадия строительства int
estate_construction_stage_human Стадия строительства (справочное) varchar
estate_price Цена decimal
estate_price_human Цена (справочное) varchar
estate_price_action Цена по акции decimal
estate_price_action_human Цена по акции (справочное) varchar
estate_currency Валюта varchar
estate_price_old Старая цена decimal
estate_price_old_human Старая цена (справочное) varchar
estate_priceNds Тип НДС varchar
estate_shouldAddNdsText Добавлять надпись "+НДС" к цене bool
estate_price_com2partn Комиссия партнеру decimal
estate_price_com2partn_human Комиссия партнеру (справочное) varchar
estate_price_comissionPayer Плательщик комиссии varchar
estate_price_range Цена decimal
estate_price_range_human Цена (справочное) varchar
estate_price_m2 Цена за м² decimal
estate_price_m2_human Цена за м² (справочное) varchar
estate_price_m2_range Цена за м² int
estate_price_m2_range_human Цена за м² (справочное) varchar
estate_price_rent Цена аренды за мес. int
estate_price_rent_human Цена аренды за мес. (справочное) varchar
estate_price_rent_m2 Цена аренды за м² за мес. int
estate_price_rent_m2_human Цена аренды за м² за мес. (справочное) varchar
estate_price_rent_range Цена аренды за мес. int
estate_price_rent_range_human Цена аренды за мес. (справочное) varchar
estate_price_rent_m2_range Цена аренды за м² за мес. int
estate_price_rent_m2_range_human Цена аренды за м² за мес. (справочное) varchar
estate_exclusive Эксклюзивный договор bool
estate_condition Состояние int
estate_condition_human Состояние (справочное) varchar
estate_floor Этаж int
estate_floor_human Этаж (справочное) varchar
estate_floors_in_house Этажность int
estate_floors_in_house_human Этажность (справочное) varchar
estate_parkSize Размер парковки varchar
estate_pano Ссылка на панораму varchar
estate_video Ссылка на видео varchar
estate_category Категория недвижимости int
estate_category_human Категория недвижимости (справочное) varchar
estate_category_type Тип int
estate_category_type_human Тип (справочное) varchar
estate_living_new Новостройка/Вторичка bool
estate_area_living Площадь жилая decimal
estate_area_living_human Площадь жилая (справочное) varchar
estate_area_kitchen Площадь кухни decimal
estate_area_kitchen_human Площадь кухни (справочное) varchar
estate_area_kitchen_living Площадь кухни-гостиной decimal
estate_area_kitchen_living_human Площадь кухни-гостиной (справочное) varchar
estate_area_gostin Площадь гостиной decimal
estate_area_gostin_human Площадь гостиной (справочное) varchar
estate_area_spaln Площадь спальни decimal
estate_area_spaln_human Площадь спальни (справочное) varchar
estate_area_wardrobe Площадь гардероба decimal
estate_area_wardrobe_human Площадь гардероба (справочное) varchar
estate_area_kladovka Площадь кладовки decimal
estate_area_kladovka_human Площадь кладовки (справочное) varchar
estate_area_prihoj Площадь прихожей/коридора decimal
estate_area_prihoj_human Площадь прихожей/коридора (справочное) varchar
estate_area_sanuzel Площадь санузла decimal
estate_area_sanuzel_human Площадь санузла (справочное) varchar
estate_area_sanuzel_2 Площадь санузла 2 decimal
estate_area_sanuzel_2_human Площадь санузла 2 (справочное) varchar
estate_area_sanuzel_3 Площадь санузла 3 decimal
estate_area_sanuzel_3_human Площадь санузла 3 (справочное) varchar
estate_area_loggia Площадь лоджии decimal
estate_area_loggia_human Площадь лоджии (справочное) varchar
estate_area_loggia_2 Площадь лоджии 2 decimal
estate_area_loggia_2_human Площадь лоджии 2 (справочное) varchar
estate_area_loggia_3 Площадь лоджии 3 decimal
estate_area_loggia_3_human Площадь лоджии 3 (справочное) varchar
estate_area_balcony Площадь балкона decimal
estate_area_balcony_human Площадь балкона (справочное) varchar
estate_area_balcony_2 Площадь балкона 2 decimal
estate_area_balcony_2_human Площадь балкона 2 (справочное) varchar
estate_has_terrace Есть терраса bool
estate_area_terrace Площадь террасы decimal
estate_area_terrace_human Площадь террасы (справочное) varchar
estate_area_terrace_2 Площадь террасы 2 decimal
estate_area_terrace_2_human Площадь террасы 2 (справочное) varchar
estate_rooms Комнат int
estate_rooms_human Комнат (справочное) varchar
estate_studia Студия bool
estate_apartments Апартаменты bool
estate_penthouse Пентхаус bool
estate_levelsCount Уровней int
estate_levelsCount_human Уровней (справочное) varchar
estate_accessNum Подъезд int
estate_accessNum_human Подъезд (справочное) varchar
estate_living_plan Планировка int
estate_living_plan_human Планировка (справочное) varchar
estate_living_sanuzel Санузел int
estate_living_sanuzel_human Санузел (справочное) varchar
estate_living_house Материал дома int
estate_living_house_human Материал дома (справочное) varchar
estate_private_house_name Внутреннее название varchar
estate_public_house_name Публичное название varchar
estate_living_balcony Балкон int
estate_living_balcony_human Балкон (справочное) varchar
estate_living_windowview Окна int
estate_living_windowview_human Окна (справочное) varchar
estate_living_complex Жилой комплекс varchar
estate_is_closedArea Закрытая территория bool
estate_category_subtype Возможное назначение int
estate_category_subtype_human Возможное назначение (справочное) varchar
estate_areaGba Общая площадь (GBA) decimal
estate_areaGba_human Общая площадь (GBA) (справочное) varchar
estate_advertTitle Продающее название text
estate_advertUrl Текстовая ссылка вместо ID varchar
estate_toDefalk Можно отдать в зачет bool
estate_windowView Вид из окон text
estate_domclick_developer_id ID Застройщика в Домклик int
estate_domclick_developer_id_human ID Застройщика в Домклик (справочное) varchar
estate_domclick_complex_id ID ЖК в Домклик int
estate_domclick_complex_id_human ID ЖК в Домклик (справочное) varchar
estate_domclick_building ID корпуса в Домклик int
estate_domclick_building_human ID корпуса в Домклик (справочное) varchar
estate_aloneStanding Отдельно стоящее здание bool
estate_tags Метки varchar
estate_has_nda Есть договор NDA bool
estate_buildingQueue Очередь стр-ва int
estate_buildingQueue_human Очередь стр-ва (справочное) varchar
estate_inServiceDate Ввод в эксплуатацию int
estate_inServiceDate_human Ввод в эксплуатацию (справочное) varchar
estate_inServiceQuartal Квартал ввода int
estate_inServiceQuartal_human Квартал ввода (справочное) varchar
estate_inServiceMonth Месяц ввода int
estate_inServiceMonth_human Месяц ввода (справочное) varchar
estate_inServiceYear Год ввода int
estate_inServiceYear_human Год ввода (справочное) varchar
estate_planName Код планировки varchar
estate_external_uuid Внешний UUID varchar
estate_shortDescription Краткое описание text
estate_storehouse_class Класс склада varchar
* Набор _human полей может быть изменен