В документации описывается API, с помощью которого можно получить доступ к данным, хранящимся в базе данных программного комплекса РКЦ: Офис. API позволяет получать статистическую и финансовую информацию о лицевых счетах, список индивидуальных приборов учёта и регистрировать новые показания.


Для использования API необходимо, чтобы к серверу приложений webapi был открыт доступ из сети Интернет. Это можно сделать, подключив услугу статического IP-адреса (при размещении сервера приложений на собственном оборудовании) у вашего поставщика Интернета и открыв доступ к порту 9050 у компьютера, где размещён модуль webapi.


Авторизация осуществляется по секретному ключу. Ключ - это значение вида f463b98225544187808655874e68d048. Для его получения необходимо в подменю Расчёты с населением выбрать пункт Параметры и, в открывшемся окне, установить флаг Разрешить использование публичного API (изменение флага доступно только для Администратора).




Программный комплекс, при этом, автоматически сгенерирует секретный ключ. Кнопка Скопировать помещает значение ключа в буфер обмена операционной системы.


Менять ключ в процессе эксплуатации не рекомендуется, т.к. сторонним разработчикам придётся также менять настройки для продолжения работы с API. Если, по какой-либо причине, возникла необходимость отказаться от услуг сторонних разработчиков - снимите флаг Разрешить использование публичного API и нажмите кнопку ОК для сохранения изменений. Доступ к API будет мгновенно закрыт. При следующей установке флага программным комплексом будет сгенерирован новый секретный ключ.


При использовании API необходимо в заголовок (header) каждого запроса добавлять параметр X-PUBLIC-API-KEY со значением секретного ключа. Для избежания DDoS-атак РКЦ: Офис принимает не больше 10 запросов в секунду. При превышении этого ограничения программный комплекс возвращает HTTP-код 429 (Too Many Requests).