API РосКвартала® (API ГИС ЖКХ)
Описание API
Общая информация:
API РосКвартала® — RESTful веб-сервис (версия 15.4.0.1) для интеграции с ГИС ЖКХ, позволяющий автоматизировать размещение и выгрузку данных (договоры, уставы, статусы, ресурсоснабжение) без ручного заполнения шаблонов. Базовый URL: https://api.roskvartal.ru/. Поддержка: JSON (Accept/Content-Type: application/json) или XML (application/xml), кодировка UTF-8, HTTPS. Все методы асинхронные (POST с MessageGuid для отслеживания). HTTP-коды: 200 (OK), 204 (NoContent), 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 406 (Not Acceptable), 500 (Internal Server Error). Ошибки: детальные причины в ответе (code, message).
Аутентификация:
- API-ключ из личного кабинета (Карточка компании на roskvartal.ru).
- Передача: Заголовок Authorization: {apiKey} или параметр apiKey в URL
- Получение: Регистрация в ЛК, запрос пробного ключа (бесплатно); отзыв — в ЛК.
Правила использования:
- Разрешено: Интеграция в CRM/1C для УО/ТСЖ; до 1000 запросов.
- Запрещено: Массовый скрейпинг; обязательна атрибуция "Данные от РосКвартал".
- Безопасность: HTTPS; соответствие 152-ФЗ.
Методы (Endpoints):
Все POST, асинхронные. Полная документация: https://api.roskvartal.ru/docs/index (Swagger UI).
- /api/management/getAsync (Договоры управления): Параметры: MessageGuid (string, опц.), ContractGuid/ContractVersionGuid/CharterGuid/CharterVersionGuid/OrgGuid (string, одно обяз.), UoGuid/FiasHouseGuid (string, обяз. в seq.), SigningDate (string, опц.), LastVersionOnly (bool, опц.). Ответ: {Contract: FullContractDto (guid, number, signingDate, status, attachments), Charter: FullCharterDto, ManagementStatus: [...], payments, objects, etc.}.
- /api/management/status/getAsync (Статусы договоров): Параметры: SearchCriterias (array[ManagementSearchCriteria], обяз., ≤100), OrgGuid (string, обяз.), MessageGuid (string, опц.). Ответ: {ContractStatus: ContractStatusDto (guid, status, objects), CharterStatus: CharterStatusDto}.
- /api/management/resourceContract/getAsync (Договоры ресурсоснабжения): Параметры: OrgGuid (string, обяз.), MessageGuid (string, опц.), ContractGuid/ContractRootGuid (string/array, одно обяз., ≤1000), ContractNumber/FiasHouseGuid/ExportContractRootGUID (string, опц.), ContractSubject (BaseResourceContractSubjectDto, опц., ≤100: ServiceType/MunicipalResource (NsiRef, обяз.), SigningDateEnd/Start (string, опц.)). Ответ: {ContractGuid, ContractRootGuid, status, attachments, subject: {serviceKind, resourceKind, volume, tariff}}. Ошибки: 400 (invalid params).
- /api/management/resourceContract/getAsyncPaginal (Договоры РС, постранично): Параметры: ContractGuid/ContractNumber/ContractRootGuid/FiasHouseGuid/ExportContractRootGUID (string/array, опц.), ContractSubject (BaseResourceContractSubjectDto, опц.), SigningDateEnd/Start (string, опц.), OrgGuid/MessageGuid (string, опц.). Ответ: {ResourceContracts: array[ResourceContractDto] (guid, rootGuid, status, attachments, subject), totalCount}.
Особенности и обновления (2025):
- Асинхронность: Отслеживание по MessageGuid (GET /api/async/{messageGuid}).
- Интеграция: SDK для 1C/Python; примеры в docs.
- Преимущества: 100% покрытие ГИС ЖКХ, ежедневные обновления, снижение времени на 80%.
API РосКвартала® — RESTful веб-сервис (версия 15.4.0.1) для интеграции с ГИС ЖКХ, позволяющий автоматизировать размещение и выгрузку данных (договоры, уставы, статусы, ресурсоснабжение) без ручного заполнения шаблонов. Базовый URL: https://api.roskvartal.ru/. Поддержка: JSON (Accept/Content-Type: application/json) или XML (application/xml), кодировка UTF-8, HTTPS. Все методы асинхронные (POST с MessageGuid для отслеживания). HTTP-коды: 200 (OK), 204 (NoContent), 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 406 (Not Acceptable), 500 (Internal Server Error). Ошибки: детальные причины в ответе (code, message).
Аутентификация:
- API-ключ из личного кабинета (Карточка компании на roskvartal.ru).
- Передача: Заголовок Authorization: {apiKey} или параметр apiKey в URL
- Получение: Регистрация в ЛК, запрос пробного ключа (бесплатно); отзыв — в ЛК.
Правила использования:
- Разрешено: Интеграция в CRM/1C для УО/ТСЖ; до 1000 запросов.
- Запрещено: Массовый скрейпинг; обязательна атрибуция "Данные от РосКвартал".
- Безопасность: HTTPS; соответствие 152-ФЗ.
Методы (Endpoints):
Все POST, асинхронные. Полная документация: https://api.roskvartal.ru/docs/index (Swagger UI).
- /api/management/getAsync (Договоры управления): Параметры: MessageGuid (string, опц.), ContractGuid/ContractVersionGuid/CharterGuid/CharterVersionGuid/OrgGuid (string, одно обяз.), UoGuid/FiasHouseGuid (string, обяз. в seq.), SigningDate (string, опц.), LastVersionOnly (bool, опц.). Ответ: {Contract: FullContractDto (guid, number, signingDate, status, attachments), Charter: FullCharterDto, ManagementStatus: [...], payments, objects, etc.}.
- /api/management/status/getAsync (Статусы договоров): Параметры: SearchCriterias (array[ManagementSearchCriteria], обяз., ≤100), OrgGuid (string, обяз.), MessageGuid (string, опц.). Ответ: {ContractStatus: ContractStatusDto (guid, status, objects), CharterStatus: CharterStatusDto}.
- /api/management/resourceContract/getAsync (Договоры ресурсоснабжения): Параметры: OrgGuid (string, обяз.), MessageGuid (string, опц.), ContractGuid/ContractRootGuid (string/array, одно обяз., ≤1000), ContractNumber/FiasHouseGuid/ExportContractRootGUID (string, опц.), ContractSubject (BaseResourceContractSubjectDto, опц., ≤100: ServiceType/MunicipalResource (NsiRef, обяз.), SigningDateEnd/Start (string, опц.)). Ответ: {ContractGuid, ContractRootGuid, status, attachments, subject: {serviceKind, resourceKind, volume, tariff}}. Ошибки: 400 (invalid params).
- /api/management/resourceContract/getAsyncPaginal (Договоры РС, постранично): Параметры: ContractGuid/ContractNumber/ContractRootGuid/FiasHouseGuid/ExportContractRootGUID (string/array, опц.), ContractSubject (BaseResourceContractSubjectDto, опц.), SigningDateEnd/Start (string, опц.), OrgGuid/MessageGuid (string, опц.). Ответ: {ResourceContracts: array[ResourceContractDto] (guid, rootGuid, status, attachments, subject), totalCount}.
Особенности и обновления (2025):
- Асинхронность: Отслеживание по MessageGuid (GET /api/async/{messageGuid}).
- Интеграция: SDK для 1C/Python; примеры в docs.
- Преимущества: 100% покрытие ГИС ЖКХ, ежедневные обновления, снижение времени на 80%.
Характеристики
Тип API :
Rest
Поставщик :
Доступ к API :
Общедоступное
Категория :
ЖКХ
Отрасли :
ЖКХ
Обновлено:
31.10.2025
Подключений :
1
Стоимость
По запросу
Загрузка комментариев...