Открытый API, вебхуки и мини-приложения для управления домами
Когда готовой связи между Unitify и другой системой нет, дорога идёт через открытый API. Это тот же интерфейс, которым пользуются сами продукты, и у него есть публичная документация.
Здесь про API, вебхуки, мини-приложения и вход из вашего сервиса: что делает каждый, как получить доступ и что настраивается под проект.
Коротко
GraphQL API, вебхуки, мини-приложения и вход через OpenID Connect работают сегодня и публично документированы. Доступ к API входит в тариф Pro. Доступ для конкретной системы или вендора и работа по сопоставлению их данных настраиваются под проект.
Для чего нужна эта связь
Подключить любую систему, которая вызывает API
Учётная система или ERP, платформа учёта ресурсов, чат-бот или ваше программное обеспечение читает и записывает данные Unitify.
Реагировать на изменения
Вебхуки сообщают вашей системе, что заявка, контакт или счёт изменились, чтобы она не спрашивала снова и снова.
Строить на платформе
Мини-приложение помещает ваш сервис внутрь панели управления или приложения жителя, и пользователи не уходят из Unitify.
Какие данные и в какую сторону идут
У каждой строки указано, работает она сегодня или настраивается под ваш проект.
- Работает сегодня
Чтение и запись: GraphQL API
Дома, квартиры, контакты, заявки, показания счётчиков, новости и счета можно запрашивать, создавать и обновлять. У биллинговых и платёжных записей есть importId для идентификатора из вашей системы.
- Работает сегодня
События наружу: вебхуки
Подписки охватывают заявки, контакты, организации, документы и счета, с полями и фильтрами по вашему выбору. Счёт также может обращаться по адресу, когда меняется статус его оплаты.
- Работает сегодня
Внутри продукта: мини-приложения
Веб-сервис работает в панели управления или приложении жителя и общается с основным приложением через библиотеку Bridge.
- Работает сегодня
Вход: OpenID Connect
Сервис с OpenID Connect позволяет своим пользователям авторизоваться в API Unitify без второго пароля.
- Настраивается под проект
Сопоставление и построение связи
Решить, какие ваши поля соответствуют нашим, и построить обмен для вашей системы.
Как получить доступ
Документация публична. Тариф и права доступа это то, что мы настраиваем вместе с вами.
- Работает сегодня
Прочитайте документацию
Модель данных, авторизация и примеры публичны.
Открыть документацию по API - Работает сегодня
Попробуйте в песочнице
В документации есть пошаговое руководство по песочнице для первых запросов.
Открыть руководство по песочнице - Работает сегодня
Адреса вебхуков
Подписки и адреса вебхуков настраиваем мы. Попросите, и мы добавим ваш.
Прочитать пример с вебхуком - Работает сегодня
Мини-приложения и вход
Мини-приложения используют библиотеку Bridge, а вход из вашего сервиса работает по OpenID Connect.
Открыть документацию по Bridge
Что нужно от вас
Сценарий использования
Что вашей системе нужно читать или записывать и как часто.
Тестовая организация
Одна организация, на которой попробуем доступ, прежде чем он коснётся настоящих данных.
Контакт с вашей стороны
Человек, который читает документацию по API и умеет принять вебхук.
Честные границы
- Доступ к API входит в тариф Pro. Актуальные условия тарифов на странице цен.
- SAML нет. Вход из другого сервиса, для сотрудников или жителей, работает по OpenID Connect, а ваш сервис мы регистрируем как провайдера.
- Связь с вашей системой это проект. API делает её возможной, а сопоставление ваших данных и построение обмена это работа, которую мы согласуем с вами.
Открытый API и вебхуки: вопросы
Есть ли публичный API?
Да. API построен на GraphQL, и его документация публична: модель данных, авторизация, примеры и руководство по песочнице.
Что можно читать и записывать?
Дома, квартиры, контакты, заявки, показания счётчиков, новости, счета и другое. Читаются, создаются и обновляются объекты одним и тем же способом.
Есть ли вебхуки?
Да. Подписки охватывают заявки, контакты, организации, документы и счета, а счёт может обращаться по адресу, когда меняется статус оплаты. Подписку мы настроим за вас.
Может ли мой сервис работать внутри Unitify?
Да, как мини-приложение в панели управления или приложении жителя, через библиотеку Bridge.
Могут ли мои пользователи входить в API с аккаунтами моего сервиса?
Да, если ваш сервис поддерживает OpenID Connect: мы регистрируем ваш сервис как провайдера. SAML не предлагается.
Доступ к API бесплатный?
Доступ к API входит в тариф Pro. Актуальные условия тарифов на странице цен.
Смотрите также
Скажите, какая у вас система
Начните бесплатно с одним домом: без карты и без звонка. Или запишитесь на разбор и назовите системы и устройства, которые нужно подключить. Каждое мы подтвердим до того, как вы что-то решите.