Привет! Меня зовут Антон Желток, и сегодня я расскажу про API ЕИСЖС.
API, как известно, – это стандартизированный программный интерфейс взаимодействия между информационными системами. Некий общий язык для передачи данных от одной ИС к другой. Без API сложно представить организованное взаимодействие модулей внутри сложных систем и интеграцию с внутренними и внешними источниками или потребителями.
API могут быть частными и публичными. Частные создаются для внутренних целей организации или системы, доступ к ним можно получить по запросу. Публичные же доступны в интернете, они позволяют разработчикам свободно использовать возможности этих интерфейсов в создаваемых приложениях. Например, при регистрации на новом ресурсе нам предлагают не создавать новую учетную запись, а использовать уже существующую учетку на Госуслугах или из популярной соцсети. Мы ежедневно сталкиваемся с картами и навигацией на различных сайтах, с агрегаторами по продаже различных товаров или авиабилетов - их работа возможна благодаря наличию публичных API сайтов поставщиков и авиакомпаний.
Среда наш.дом.рф уникальна и содержит информацию обо всех застройщиках и их объектах на территории России. Если застройщик строит дом с привлечением средств дольщиков, то по федеральному закону № 214-ФЗ "Об участии в долевом строительстве …" он обязан опубликовать проектную декларацию в ЕИСЖС. Эти данные доступны любому посетителю портала наш.дом.рф. Но для дальнейшего промышленного использования данные в виде pdf-файлов непригодны. Однако в системе проектные декларации хранятся в машиночитаемом виде и для профессиональных участников рынка мы сделали API.
Документированный инструмент взаимодействия упрощает для участников рынка получение сведений о рынке жилищного строительства РФ. На сегодняшний день в ЕИСЖС имеется информация о восьми с половиной тысячах застройщиков, которые построили и продолжают строить более тридцати четырех тысяч объектов по всей стране. Несомненно, такой массив данных представляет интерес для анализа, построения прогнозных моделей и изучения состояния рынка.Для удобной работы с таким большим объемом данных мы создали несколько групп методов, которые позволяют точно получить ту информацию, которая требуется для решения конкретной бизнес задачи клиента. Таких групп шесть – в группах, представлены методы, которые возвращают данные о группах компаний, о застройщиках, о жилых комплексах, об объектах строительства, о генеральных подрядчиках и о проблемных объектах строительства. Каждая из групп содержит в себе несколько методов, которые передают сведения разного уровня детализации. Помимо данных в машиночитаемом виде с помощью методов API можно получить файлы с информацией о застройщике или объекте строительства, которые публикуют застройщики, разрешительные и контролирующие органы. Стоит также отметить наличие информации о проблемных объектах строительства. Их полный перечень со всеми характеристиками также доступен в специальной группе методов по работе с проблемными объектами.
Приведу несколько примеров решения бизнес задач с применением данных API ЕИСЖС:
Пример 1
Перед застройщиком стоит задача расширить географию своих проектов. Тогда для подготовки работы по новому направлению он может получить данные обо всех объектах строительства в интересующем регионе и узнать каковы характеристики построенных или строящихся домов, кто является самым востребованным генеральным подрядчиком, какие средние площади квартир предлагают конкуренты в своих проектах и какими темпами идут продажи. На основе полученных данных застройщик может сделать выводы и учесть все особенности спроса и предложения в своих новых проектах для получения максимальной эффективности от работы.
Пример 2
Компании поставщику инженерного оборудования для многоквартирных домов нужно найти новых заказчиков для реализуемой продукции. Используя API ЕИСЖС компания сможет максимально быстро получать информацию о новых проектах, которые появляются в их зоне интересов. Руководствуясь сведениями об объекте можно оценить объем возможного спроса в проекте, а информацию о застройщике поможет найти необходимые контакты.
Пример 3
Также в качестве примера применения данных, получаемых по API, может быть задача поиска подходящего коммерческого помещения для бизнеса любого размер и сферы деятельности. Данные о коммерческих помещениях в составе строящегося дома также представлены наряду с информацией о количестве квартир, а указание класса недвижимости позволит точно определить целевую аудиторию для бизнеса.
Применение данных API ЕИСЖС не ограничивается практически ничем, а при наличии умелых рук и тщательного анализа способно решить множество задач не только застройщиков, но и других компаний так или иначе имеющих отношение к строительству.
Использование API сокращает в разы время, за которое информация поступает от источника к потребителю. Среднее время ответа сервиса исчисляется в сотых долях секунды.
О применяемых технологиях
В качестве системы класса API Management была выбрана Gravitee.io. Это платформа с открытым исходным кодом, она легко масштабируется и является быстродействующей. Gravitee это центр управления всеми API, которые созданы в ЕИСЖС и в том числе сервисом API ЕИСЖС. Здесь создаются планы подписки, собрана вся аналитика по использованию API и доступен просмотр логов.
Для сбора логов – используется elasticsearch. Данный поисковый движок написан на Java и использует json rest api. Он хорошо подходит для сложного поиска по базе документов.
Backend API написан на Java и работает с базой данных под управлением СУБД PostgreSQL.
Аутентификация клиентов происходит в keycloak по протоколу OAuth 2.0. Протокол OAuth не требует от пользователя ввода пароля во время входа в систему, а использует токены авторизации, которые подтверждают доверительные отношения между поставщиком услуг, в нашем случае API ЕИСЖС, и потребителями.
(затерт автором)