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

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

Параметр

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

Пример

Описание

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

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

Да*

ivan@somedomain.tld

Почта клиента, массивом либо через запятую.

tags

Ипотека, Молодая семья

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

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)

Параметр

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

Пример

Описание

domain

Да

"вашсайт.рф"

Домен, зарегистрированный в MacroCRM

time

Да

1234567890

unix 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	Да	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 из последней выборки)

Параметр

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

Пример

Описание

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

Нет

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

separate

Нет

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

Нет

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'=>'Ошибка аутентификации']

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

Last updated 5 months ago