Обзор API

Базовый URL

https://api.estatekit.io/v1

API-ключ тенанта передаётся в заголовке X-API-Key. Подробности — в разделе Аутентификация и доступ.

Все ответы возвращаются в формате JSON с заголовком Content-Type: application/json.

{
  "id": 42,
  "status_id": 5,
  "status_name": "approved"
}

{
  "detail": "Описание ошибки"
}

Код	Описание
400	Некорректный запрос (невалидный JSON, отсутствуют обязательные поля)
401	Отсутствует или невалидный API-ключ
403	API-ключ не имеет нужного разрешения
404	Ресурс не найден
409	Конфликт (например, недопустимый переход статуса)
429	Превышен лимит запросов
500	Внутренняя ошибка сервера

Метод	Путь	Описание	Доступ
POST	`/properties`	Подача объекта на MLS	API-ключ
POST	`/properties/{id}/suspend`	Приостановка публикации	API-ключ, листинг-агент
POST	`/properties/{id}/resume`	Возобновление публикации	API-ключ, листинг-агент

Метод	Путь	Описание	Доступ
GET	`/mls/properties`	Поиск объектов	Публичный
GET	`/mls/properties/{id}`	Карточка объекта	Публичный
GET	`/mls/properties/{id}/contact`	Контакт собственника	API-ключ

Метод	Путь	Описание	Доступ
POST	`/webhooks`	Создать подписку на события	API-ключ
GET	`/webhooks`	Список подписок тенанта	API-ключ
DELETE	`/webhooks/{id}`	Удалить подписку	API-ключ
POST	`/webhooks/{id}/test`	Отправить тестовое событие	API-ключ
GET	`/webhooks/{id}/logs`	История доставки	API-ключ