REST API платформы
REST API документируется в формате OpenAPI и доступен через Swagger UI. Интерактивная документация позволяет изучить структуру запросов и ответов, протестировать методы непосредственно в браузере и использовать спецификацию для автоматической генерации клиентских библиотек.
API платформы охватывает основные инженерные сущности Seenaptec:
- контроллеры и OSDP-линии;
- устройства и их компоненты;
- производители и модели оборудования;
- объекты доступа и их типы;
- конфигурацию платформы;
- аутентификацию и параметры безопасности.
Документация содержит описание моделей данных, параметров запросов, кодов ответов и примеры использования для интеграции с внешними системами.
Основные разделы API
- Controllers
- OSDP Lines
- Devices
- Access Objects
- Vendors & Models
- Security API
- Health API