API Домопланера

У Домопланера есть API для управления данными.

Актуальная версия публичного API доступна по ссылке:
https://documenter.getpostman.com/view/4614387/2s8ZDcyKfe  

Обычно сюда заглядывают по двум основным причинам:

1) нужно читать наличие себе на сайт или куда-то ещё
2) нужна интеграция с BI или 1С

Если запрос про это же, то давайте разберем.

Синхронизация наличия

Если вам нужно только наличие, то для этого у нас есть отличный формат фидов Домопланер JSON. API тут не нужно, так как фиды сразу предоставляют все нужные данные в удобном формате без всяких авторизаций.

Ознакомьтесь с нашими советами как обновлять квартиры на сайте, а так же больше про формат Домопланер JSON.

Интеграции с BI и 1С

Для всех внешних систем у нас есть фиды по всем главным сущностям: клиент, сделка, подписант, поступление, расчетные счета, документы и так далее.

Если необходимо получать данные от Домопланера, то фид будет идеальным вариантом. Фиды с данными вы можете найти в интеграции под названием "Экспорт данных". Подробнее про то как настроить фиды.

Если все-таки API

Подключение интеграции осуществляется в разделе:

"Настройки" →  "Интеграции" →  "Другое" →  "API"

Нахождение API в Домопланере

Добавьте ключ соответствующей кнопкой, откроется форма:

Карточка создания ключа

Разберём основные моменты:

• Название для Домопланера - Название для ключа. Отображается во внутренних интерфейсах.
• Ключ для запросов - Автоматически созданный ключ. Вам достаточно его скопировать и передать разработчикам.
• Разрешённые IP - Укажите через Enter IP адреса, с которых разрешено чтение ключа. По умолчанию можно читать всем
• Переключатель "Активный ключ" - Если активна, то отображается в Домопланере в интерфейсах создания договоров и пр.

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

Пример отображения количества запросов и дата последнего

В верхнем левом углу в интеграции есть кнопка "Посмотреть логи" – она позволяет увидеть все обращения к API с детализацией запроса и ответа.