Телефоны клиента массивом, либо через запятую.
\*либо телефон, либо почта клиента должны быть заполнены.
| |
| email | Да\* | | Почта клиента, массивом либо через запятую. | |
| 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**. | |
| 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 | Да | 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 из последней выборки)
|
**Результат запроса возвращается в 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#/)
