REST API ЛЭРС УЧЁТ

Сервер ЛЭРС предоставляет REST API, с помощью которого можно проводить интеграцию сторонних систем.

История изменений

В этом разделе описаны изменения, из-за которых потребуется переписывать интеграционные сервисы. Мы стараемся максимально обеспечить совместимость API версии v1 и старше, но в случае если это невозможно, мы оставляем за собой возможность поменять API для того, чтобы сделать его более логичным и удобным.

Документация

Для получения описания доступных интерфейсов перейдите по ссылке http://адрес_сервера_лэрс_учёт:10000/api/swagger

Если у вас ещё не установлен сервер ЛЭРС УЧЁТ, можете воспользоваться документацией нашего сервера.

Аутентификация и авторизация

Для авторизации используются ключи приложения API key, которые нужно передавать в каждом запросе в заголовке x-lers-api-key. Ключи создаются для пользователя и позволяют выполнять все доступные пользователю операции на доступных для него объектах. Чтобы зарегистрировать ключ приложения, откройте карточку свойств пользователя, и на закладке "Приложения" создайте новое приложение. После создания скопируйте и сохраните полученный ключ.

Генерация исходного кода

Наш API поддерживает спецификацию OpenApi, это означает, что на основе спецификации можно сгенерировать исходный код для работы с API для большинства языков программирования.

Для этих целей можно использовать специальные инструменты, например Swagger Codegen или NSwag Generator. Для генерации исходного кода следуйте инструкции.

Редактирование объектов

В версии 3.43 мы начали реализацию редактирования сущностей с помощью операции PATCH. Это позволяет отредактировать только часть полей без необходимость предварительно загружать все остальные свойства объекта. Для того, чтобы передать новые значения используется формат jsonpatch.

Например, чтобы поменять комментарий модели оборудования, используется запрос

PATCH /api/v1/core/equipment/ID/
[
    {
        "op": "add",
        "path": "/Comment",
        "value": "НОВЫЙ_КОММЕНТАРИЙ"
    }
]

Редактирование устройства

Поддерживается редактирование следующих полей:

Поле	Описание
/Comment	Комментарий
/SealNumber	Номер пломбы госповерителя
/LastCalibrationDate	Дата последней поверки
/ScheduledCalibrationDate	Дата планируемой поверки.