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

Для получения возможности использовать функционал api по передаче ключей предварительно необходимо настроить /manual/integracii/sait_kompanii/integracija_s_saitom.md интеграцию вашего сайта с MACRO

Бизнес процесс по передаче квартир происходит в 3 этапа

  1. Ваш сервис запрашивает список объектов, которые готовы к передаче. API в ответ возвращает список из номеров объектов, сгруппированный по домам. В выборку попадают объекты в статусе «Сделка проведена» с указанной фактической датой готовности к передаче.

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

  3. Сервис отправляет в API запрос на бронирование времени под передачу

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

https://api.macrocrm.ru/estate/transfer/getReadyFlats/

Метод: GET или POST

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

Параметр

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

Пример

Описание

time

Да

1234567890

unix timestamp запроса

domain

Да

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

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

token

Да

md5(domain+time+app_secret)

пример на php: $token = md5($domain . time() . $app_secret)

category

storageroom

Ограничивает выборку объектов с учетом указанной категории недвижимости.

Квартиры - flat Парковки - garage Кладовые - storageroom Коммерческие помещения - comm

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

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

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

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

Параметр

Описание

status_code

Код ответа сервера

message

В случае ошибки содержит ее описание

data.houses

Массив со списком домов

data.houses[].id

id дома

data.houses[].title

Название жома

data.houses[].flats

Массив с номерами квартир готовых к передаче

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

https://api.macrocrm.ru/estate/transfer/getFreeTimes/

Метод: GET

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

Параметр

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

Пример

Описание

time

Да

1234567890

unix timestamp запроса

domain

Да

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

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

token

Да

md5(domain+time+app_secret)

пример на php: $token = md5($domain . time() . $app_secret)

transfer_date

Да

"2020-06-11T00:00:00+05:00",

Дата, для которой нужно вернуть список доступных временных промежутков для записи на передачу квартир

house_id

Да*

123

Идентификатор дома, по которому нужно вернуть список Параметр обязательный, если компания для каждого дома использует отдельный график передачи квартир

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

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

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

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

Параметр

Описание

status_code

Код ответа сервера

message

В случае ошибки содержит ее описание

data

Массив со списком доступных временных промежутков

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

https://api.macrocrm.ru/estate/transfer/add/

Метод: POST

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

Параметр

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

Пример

Описание

time

Да

1234567890

unix timestamp запроса

domain

Да

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

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

token

Да

md5(domain+time+app_secret)

пример на php: $token = md5($domain . time() . $app_secret)

transfer_date

Да

"2020-06-11T11:00:00+05:00"

Дата и время, на которое планируется передача ключей

house_id

Да

123

Id дома в котором находится объект недвижимости

flat_num

Да

"1.9-7-4"

Номер объекта недвижимости (квартиры, парковочного места и т.д.)

phone

Да

"+7900000000"

Телефон любого из дольщиков участвующих в сделке со стороны покупателя

category

storageroom

Категория объекта, в который требуется добавить запись на осмотр.

Квартиры - flat Парковки - garage Кладовые - storageroom Коммерческие помещения - comm

Если категория не будет передана - запись на осмотр добавится в первый найденный объект с совпадающим номером.

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

{<br></br>
"domain": "вашсайт.рф",<br></br>
"time": "1623131826",<br></br>
"token": "db71dc3c424ecb2f9ba6e16df2d3369e",<br></br>
"transfer_date": "2020-06-11T11:00:00+05:00",<br></br>
"phone": "+7900000000",<br></br>
"flat_num": "1.9-7-4",<br></br>
"house_id": "123"<br></br>
}

Last updated