Функционал виджетов MACRO позволяет открыть каталог недвижимости, кабинет агента или кабинет клиента кликом по любой кнопке Вашего сайта. Также можно открыть виджет с заданными параметрами фильтров или открыть только конкретный дом / конкретный жилой комплекс.
Для открытия виджета посредством JS SDK нужно выполнить 2 шага: установить код виджета на страницу и разместить обработчик на нужной Вам кнопке, ссылке или любом другом элементе сайта.
#Установка кода виджета
Установите код виджета перед закрывающим тегом </body>. Пример кода, встраивающего каталог недвижимости:
<div class="mcrm-inline-form" data-type="catalog"></div>
<script type="text/javascript">(function (d, w) {var n = d.getElementsByTagName("script")[0], s = d.createElement("script"); s.type
= "text/javascript"; s.async = true; s.src = "https://api.macroserver.ru/estate/embedjs/?domain="+window.location.host; n.parentNode.insertBefore(s, n)})(document, window)</script>
Адрес сервера MACRO, на котором установлена система, используемый в примере — api.macroserver.ru. Доменное имя может отличаться, уточните в техподдержке актуальный адрес сервера Вашей компании.
Параметр data-type отвечает за тип виджета, который будет открываться по умолчанию:
data-type="catalog" — каталог недвижимости
data-type="agent" — кабинет агента
data-type="customer" — кабинет клиента
Установка данного кода подключит виджет на сайт и является минимальной конструкцией, которую можно дополнить следующими параметрами:
| Имя параметра | Возможные значения | Описание |
|---|---|---|
data-autoinit | true / false | Инициализация виджета при запуске страницы с кодом. Добавьте команду, если при клике по кнопке нужна быстрая загрузка виджета |
data-autoshow | true / false | Инициализация и запуск виджета при запуске страницы с кодом. Добавьте команду, если нужно сразу запускать виджет при переходе на страницу |
data-views | Значения через запятую:facades,floor,bigGrid,smallGrid,plans,list,objects,description,online | Используйте для задания списка разрешённых видов дома. Если параметр не определён, то разрешены все виды дома. |
data-noagentbutton | true / false | Используйте для установки виджета кабинет агента MACRO без кнопки «Войти в агентский кабинет» |
data-iframemode | true / false | Используйте для принудительной установки виджета в режиме iframe. Настройка виджетов «Iframe mode», установленная для домена в системе MACRO, будет игнорироваться |
data-noleads | true / false | Используйте для установки виджета без кнопки отправки заявки в каталоге (для реализации «цифровой витрины» объектов). В кабинете агента будет исключена только кнопка отправки заявки во встроенном каталоге (пункт меню «Быстрая заявка» уберите настройкой виджета, если требуется) |
data-nostats | true / false | Используйте для установки кабинета агента без страницы «Мой кабинет». |
Пример использования:
<div class="mcrm-inline-form"
data-type="catalog"
data-views="floor,bigGrid,smallGrid,plans"
data-autoinit="true"
data-autoshow="false">
</div>
#Обработчик на нужной Вам кнопке
- Открытие виджета без предварительной инициализации:
macrocrm.initCatalogAndShow({…Параметры…})
- Открытие виджета при условии предварительной инициализации:
macroCatalogShow({…Параметры…})
- Закрытие виджета без сброса инициализации:
macroCatalogHide()
Дополните обработчик нужными параметрами:
| Имя параметра | Возможные значения | Описание |
|---|---|---|
type | catalog — каталог недвижимостиagent — кабинет агентаcustomer — кабинет клиента | Тип виджета |
complexId | Целое число | ID жилого комплекса — при его передаче виджет откроется на нужном жилом комплексе. Уточните ID группы домов в чате поддержки или самостоятельно выясните его в системе MACRO |
complexView | Строка — одно из перечисленных значений:list — карточки домовplan — генпланobjects — список объектов | Вид жилого комплекса — используется, если передан complexId, и уточняет вид ЖК, который будет открыт по умолчанию |
houseId | Целое число | ID дома — при его передаче виджет откроется на нужном доме. Уточните ID дома в чате поддержки или самостоятельно выясните его в системе MACRO |
houseView | Строка — одно из перечисленных значений:facades — фасадfloor — этажbigGrid — шахматкаsmallGrid — плиткаplans — планировкиobjects — список объектовdescription — информация о домеonline — онлайн-камераpanorama — панорама дома | Вид дома — используется, если передан houseId, и уточняет вид дома, на котором будет открыт дом по умолчанию |
estateId | Целое число | ID объекта — при его передаче виджет откроется на конкретном объекте. Уточните ID объекта в чате поддержки или самостоятельно выясните его в системе MACRO |
presMode | Строка — одно из перечисленных значений:house — конкретный домcomplex — конкретный жилой комплекс | При использовании виджет откроется в режиме конкретного ЖК или дома. Используется, если передан complexId или houseId |
category | Строка — одно из перечисленных значений:flat — квартиры,apartment — апартаменты,storageroom — кладовые,garage — машино-места,comm — коммерческая недвижимость,house — малоэтажная недвижимость,land — земельные участки | При использовании виджет откроется с предустановленной категорией объектов |
locale | Строка — одно из перечисленных значений языка:ru — русскийen — английскийcnr — черногорскийkk — казахскийka — грузинскийuz_Latn — узбекскийhy — армянский | При использовании виджет откроется с предустановленным языком |
noleads | true / false | При использовании виджет откроется без кнопки отправки заявки в каталоге (реализация «цифровой витрины» объектов) |
nostats | true / false | При использовании кабинет агента будет открыт без страницы «Мой кабинет» |
filters | Объект — список свойств со значениями для предустановки фильтров: Список используемых фильтров: geo_city — ID городаstudio — признак студииrooms — множественноеfloors — множественноеrestorations — множественноеtags — множественноеriser_side — множественноеareaFromareaTopriceFrompriceTopriceM2FrompriceM2TopriceRentFrompriceRentTopriceRentM2FrompriceRentM2Topromos — множественное | При использовании виджет откроется с предустановленными фильтрами |
Для множественных свойств укажите значения в массиве через запятую. Например, если Вы планируете открыть виджет с фильтром по «1,2-комнатные, только студии», то используйте:
{filters: {rooms: [1,2], studio: 1}}
Пример использования сочетания фильтров:
macroCatalogShow({locale:'en', geo_city: 2512, houseId: 191020, category: 'flat', houseView: 'smallGrid', presMode: 'house'})
Если на странице размещён код встраивания каталога недвижимости, а Вам нужно открыть кабинет агента на этой же странице, то на нужную кнопку разместите обработчик:
onclick="macrocrm.initCatalogAndShow({type: 'agent'})"