API Передача ключей

Для получения возможности использовать функционал API по передаче ключей предварительно необходимо настроить интеграцию Вашего сайта с MACRO.

#Бизнес-процесс по передаче квартир

Происходит в 3 этапа:

1. Ваш сервис запрашивает список объектов, которые готовы к передаче. API в ответ возвращает список из номеров объектов, сгруппированный по домам. В выборку попадают объекты в статусе Сделка проведена с указанной фактической датой готовности к передаче.
2. Пользователь выбирает интересующий его дом и удобную дату. Сервис отправляет эти данные в API и в ответ получает список свободных временных промежутков для записи на передачу.
3. Сервис отправляет в API запрос на бронирование времени под передачу.

#API 2.0

С выпуском версии MacroAPI v2 для работы с функционалом передачи ключей обязательным требованием стало использование API-ключей для аутентификации и авторизации запросов. Подробнее о там как добавить API-ключ Вы можете ознакомится в статье.

О том какие параметры запросов используются в функционале API по передаче ключей, Вы можете узнать в разделе EstateTransferПереход на внешний сайтhttps://api.macroserver.ru/docs/api/v2/#tag/EstateTransfer документации.

#API 1.0

#Получение списка объектов готовых к передаче

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

https://api.macrocrm.ru/estate/transfer/getReadyFlats/Переход на внешний сайтhttps://api.macrocrm.ru/estate/transfer/getReadyFlats/

Метод: GET или POST

#Пример запроса

{
"domain": "вашсайт.рф",
"time": "1623717393",
"token": "4ad523e0f803420bc52062a3b76658d0"
}

#Пример ответа

{
    "status_code": 200,
    "data": {
        "houses": [
            {
                "id": "123",
                "title": "3 очередь бизнес-класс",
                "flats": [
                    "1.8-12-1",
                    "1.8-13-2",  …
                ]
            },
            {
                "id": "124",
                "title": "Бизнес-класс 2 очередь",
                "flats": [
                    "К-1.4-7-1"
                ]
            },  ….             
        ]
    },
    "message": "Выполнено"
}

#Получение списка доступных временных промежутков для записи на передачу квартир

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

https://api.macrocrm.ru/estate/transfer/getFreeTimes/Переход на внешний сайтhttps://api.macrocrm.ru/estate/transfer/getReadyFlats/

Метод: GET

#Пример тела запроса

{
    "domain": "вашсайт.рф",
    "time": "1623095129",
    "token": "0e8e424732fccbe827ca486feb925c47",
    "transfer_date": "2020-06-11T00:00:00+05:00",
    "house_id": "123"
}

#Пример ответа от сервера

{
    "status_code": 200,
    "data": {
        "08:30",
        "09:00",
        "13:00",
        "17": "13:30",
    },
    "message": "Выполнено"
}

#Резервирование времени для осмотра и передачи ключей

⚠️ Важно! Убедитесь что в настройке компании «Передача ключей: Сотрудники компании, ответственные за передачу квартир» указан хотя бы один ответственный менеджер.

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

https://api.macrocrm.ru/estate/transfer/add/Переход на внешний сайтhttps://api.macrocrm.ru/estate/transfer/add/

Метод: POST

Заголовок: Content-Type: application/json

Формат данных: JSON

#Пример запроса

{
    "domain": "вашсайт.рф",
    "transfer_date": "2025-08-27T10:00:00+03:00",
    "phone": "+7 (900) 000-000",
    "name": "Иванов Иван  Иванович",
    "flat_num": "1.9-7-4",
    "house_id": 8561992,
    "category": "flat",
    "manager_id": 86998,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ",
    "time": 1704076800,
}

#Пример успешного ответа от сервера

{
    "status_code": 200,
    "data": {
        "message": "Дата осмотра зарезервирована"
    },
    "message": "Спасибо! Мы записали Вас на указанное время",
    "success": true
}

#Пример ответа от сервера с ошибкой

{
    "status_code": 609,
    "error": true,
    "message": "Выбранная дата недоступна для записи"
}

#Описание возможных ошибок