Skip to main content

Доступ к документации по API

В платформе предусмотрена автоматически собираемая документация по API.

Для доступа к документации по API НСИ в установленной версии ПО введите в адресной строке браузера:

https://app-name:3275/swagger

image27.png

Этот интерфейс позволяет не только увидеть список доступных методов REST API, но также и требования к телу запроса, а также предоставляет возможность опробовать эти методы.

Методы НСИ сгруппированы в несколько частей по функциям:

Commands -- команды редактирования модели на сайте ПРОСТОР

Entities -- работа с сущностями информационной модели

FileApi -- методы файлового веб-сервера платформы ПРОСТОР

Guid -- системный API

Nsi -- общие методы НСИ (в том числе импорт/экспорт)

Users -- методы касающиеся управления пользователями

Для доступа к документации по API сервиса архивирования в установленной версии ПО введите в адресной строке браузера:

https://app-name/swagger

где app-name -- доменное имя, единая точка входа в пользовательские интерфейсы ПРОСТОР.

image28.png