РИАС ЖКХ предоставляет два инструмента для автоматизации процессов передачи информации в сторонние системы и сбора данных из сторонних систем с целью автоматического размещения в ГИС ЖКХ. С использованием этих инструментов можно наладить следующие процессы:
- размещение в ГИС ЖКХ показаний приборов учета
- размещение в ГИС ЖКХ платежных документов
- актуализация сведений в ГИС ЖКХ (договоры управления/ресурсоснабжения, объекты жилого фонда, лицевые счета, приборы учёта)
- сбор данных из ГИС ЖКХ
Укрупненная функциональная схема демонстрирующая место API в процессе информационного взаимодействия с ГИС ЖКХ через РИАС ЖКХ:
Как видно из схемы, API можно использовать как с помощью обменных форматов (через службу сбора данных), так и с помощью веб-методов. Через веб-интерфейс Заказчик может работать с данными первичных реестров, загружать сведения в обменных форматах и/или контролировать ход автоматического размещения данных в ГИС ЖКХ.
Подробная документация базового сценария интеграции через REST API
Сценарий подключения к API:
- Заказчик регистрируется в системе РИАС ЖКХ.
- РИАС ЖКХ автоматически синхронизирует состояние первичных реестров (договоры, ОЖФ, ЛС, ПУ) с ГИС ЖКХ.
- По мере необходимости Заказчик дополняет сведения по первичным реестрам (через веб-формы или с использованием обменных форматов). В этом случае РИАС автоматически синхронизирует состояние реестров с ГИС ЖКХ.
- В ИС Заказчика реализуется возможность предоставления данных через REST API либо возможность выгрузки данных в обменных форматах.
- Для интеграции через REST API Заказчик получает через Веб-интерфейс ключ аутентификации для своей ИС, который будет использоваться для подписи запросов к REST API.
- При интеграции с использованием обменных форматов Заказчик либо вручную регулярно загружает в РИАС экспортированные файлы, либо настраивает в РИАС возможность автоматической загрузки файлов по расписанию по заданному URL.
REST API
REST API РИАС ЖКХ это набор веб-методов, расположенных по адресу:
https://api.rias-gkh.ru/v2.0/
Для аутентификации запросов используется ключ аутентификации, который можно получить в личном кабинете после регистрации.
Поддерживаемый формат запроса и ответа от REST API - JSON.
Для тестирования API развернут тестовый стенд. Он подключен к тестовому
стенду ГИС ЖКХ СИТ1.
Это позволяет проверить работу API на копии рабочего сервера ГИС.
Основные реестры:
- /resource-supply-contracts - договоры ресурсоснабжения
- /management-contracts - договоры управления
- /houses - объекты жилого фонда
- /accounts - лицевые счета
- /metering-devices - приборы учета
- /metering-devices-values - показания приборов учета
- /payment-documents - платежные документы
- /nsi - справочники НСИ
Полная документация по всем веб-методам доступна по ссылке:
https://api.rias-gkh.ru/v2.0/docs
Интеграция через обменные форматы
Для автоматической загрузки данных в ГИС ЖКХ можно использовать обменные форматы.
Спецификации обменных форматов:
