Синхронизация с сайтом

Актуальное наличие на сайте

Для актуализации квартир на сайте рекомендуем использовать схему актуализации через фид формата Домопланер JSON [подробнее о формате фида]

1️⃣ Первая загрузка фида

При первой загрузке нужно сделать сопоставление: на сервере сайта прописываем какие есть планировки, какие у них изображения, характеристики и прочее. А так же указываем номера квартир в доме, которые отвечают данным планировочным решениям. По этим номерам при каждой сверке с фидом мы включаем-отключаем квартиры. Если какая-то планировка вовсе не содержит активных квартир, то её тоже стоит скрыть с сайта (тут уже на усмотрение вашей логике)

2️⃣ Постоянное обновление данных

Запрашиваем данные фида раз в 5 минут и сверяем их с текущим слепком на сервере вашего сайта

3️⃣ Актуализируем данные

При каждой загрузке фида проводится актуализация – сверяем по номерам квартир квартиры на сайте с квартирами в фиде. Если статус квартиры в фиде изменился – меняем её и на сайте.

Отправка заявок с сайта в CRM

Описание запроса с примерами в Postman вот тут

1️⃣ Получение API-ключа

Зайдите в Домопланере в раздел Настройки – Интеграции и выберите “API”. Создайте новый API-ключ. Скопируйте и передайте его разработчикам. Он и нужен будет для выполнения запросов. Далее по тексту API_KEY

2️⃣ Отправка заявки

POST https://domoplaner.ru/api/leads
HEADER Authorization: "Bearer API_KEY"

Номер телефона – единственное обязательное поле, необходимое для создания лида. Чтобы добавить новый лид, отправьте POST запрос на путь выше.

Домопланер принимает следующие body-параметры:

name [string]
Имя лида. Как хотите назвать его в Домопланере

phone [string]
Телефон клиента формата 79131112233. Обязательное

project_id [int]
id проекта внутри ДП, к которому нужно привязать лид.
Можно найти в настройках проектов и домов

comment [string]
комментарий, который добавится в заявку. Можно использовать \n для переноса строк и *выделение астерисками (звездочками)* для жирного текста

-----------
Далее поля, которые работают только если с заявки создается новый лид:

tags [string]
список меток через запятую, не чувствителен к регистру. При создании перебираем указанные метки. Если находим с таким названием в Домопланере – ставим метку на лида. Не работает, если лид уже создан на момент заявки. Список всех меток можно посмотреть в настройках лидов 

responsible_id [string]
ID пользователя, которого сделать ответственным при создании лида. Если лид уже создан, то будет выставлена задача на текущего ответственного. ID можно взять в списке пользователей в ДП


При успешном добавлении лида Домопланер ответит статусом 200, в теле письма много интересного (смотрите в примере в Postman)

? При ошибке сервер отвечает статусом 409 если хотя бы одного из обязательных параметров нет.

⚠️ Крайне рекомендуем заполнять поле comment. Добавьте туда:

– точное время заявки,
– страницу, с которой оставлена заявка
– название формы, по которой оставили заявку

Отправка уведомлений от агентств недвижимости c сайта в CRM

Если вы работаете с агентствами недвижимости, то можете настроить получение уведомлений от агентств сразу в Домопланер.

Схема работы:

1️⃣ Создайте страницу для риэлторов

Вы создаете страницу на сайте “Риэлторам”. На этой странице должна располагаться форма для отправки уведомления. Необходимые поля
– ФИО клиента (текстовое поле input[type=”text”])
– Телефон клиента (текстовое поле input[type=”text”])
– Комментарий по клиенту (текстовое поле textarea[rows=”3” maxlength=”500”])
– Агентство недвижимости (выпадающий список select)
– ФИО риэлтора (текстовое поле input[type=”text”])
– Телефон риэлтора (текстовое поле input[type=”text”])

При заходе на эту форму нужно загрузить список агентств, с которыми сотрудничает застройщик, из Домопланера (подробнее далее).

Пример как реализовано у одного из застройщиков: https://sibakademstroy.brusnika.ru/realtors/notification/

2️⃣ Создайте обработчик заявок

Создаете серверный скрипт, который будет принимать данные с этой формы

3️⃣ Отправьте заполненную форму в Домопланер

Пользователь заполняет форму и отправляет её вам на сервер. Ваш скрипт принимает данные, валидирует их перед отправкой в Домопланер, и отправляет.

4️⃣ Ответьте пользователю о приеме формы

Отвечаем пользователю, что с ним свяжутся или что-то в этом роде в зависимости от бизнес-процесса застройщика.


Что нужно, чтобы отправить агентский лид в Домопланер?

1️⃣ Получение API-ключа

Зайдите в Домопланере в раздел Настройки – Интеграции и выберите “API”. Создайте новый API-ключ. Скопируйте и передайте его разработчикам. Он и нужен будет для выполнения запросов. Далее по тексту API_KEY

2️⃣ Получение списка агентств недвижимости

Описание запроса с примерами в Postman вот тут

GET https://domoplaner.ru/api/agencies/get-list?addEmpty=1
HEADER Authorization: "Bearer API_KEY"

В ответ массив с агентствами, состоящий из {id: number, name: text}. Если добавить в запрос GET параметр addEmpty=1, то в список добавится пункт “Нет в списке”.

Этот список лучше реализовать через кэширование. Когда пользователь делает запрос на страницу формы, вы идете запрашивать список АН и кэшируете ответ на 30 минут. В течение всех этих 30 минут вы отдаете пользователям кэшированую версию списка АН.

Не рекомендуется запрашивать этот список перед КАЖДЫМ заходом на страницу отправки уведомления, т.к. при DDOS-атаке вашего сайта количество запросов в Домопланер может превысить лимит, и синхронизация с Домопланером перестанет работать определенное время.

ВАЖНЫЙ НЮАНС: Почему нельзя загрузить список агентств с фронтенда через javascript? Загрузка данных об агентствах идет через API-ключ. Через этот API-ключ можно произвести и другие действия. Его нужно хранить в секрете и только ваш сервер должен знать о нем. Поэтому, мы предлагаем проксировать все запросы от пользователей, связанные с Домопланером, через ваш сервер.

3️⃣ Отправка уведомления

Описание запроса с примерами в Postman вот тут

POST https://domoplaner.ru/api/leads/from-agency
HEADER Authorization: "Bearer API_KEY"

Повторимся, этот POST запрос выполняется с ВАШЕГО сервера, а не с браузера клиента. В GET параметре не забудьте передать API-ключ в параметре apik

CRM принимает следующие body-параметры (через x-www-form-urlencoded):
client_fio (ФИО клиента, обязательное)
client_phone (телефон клиента формата 79131112233, обязательное)
realtor_fio (ФИО клиента, обязательное)
realtor_phone (телефон риэлтора формата 79131112233, обязательное)
realtor_agency (id агентства, которое получено из шага №1, обязательное, но можно, конечно, и текстом. Но в таком случае не будет автоматической привязки внутри Домопланера)
+ другие поля, посмотрите в Postman

✅ При успешном добавлении лида Домопланер ответит статусом 200, подробнее про ответы в примерах в Postman

? При ошибке сервер отвечает статусом 409 если хотя бы одного из обязательных параметров нет