Приложение C. Интеграционный API¶
AppSec.GenAI предоставляет REST API для интеграции с внешними инструментами и приложениями — например, с CI/CD-конвейерами, системами мониторинга или корпоративными порталами. Через API доступны все основные операции, выполняемые в веб-интерфейсе: управление моделями, создание профилей сканирования, запуск сканирований и получение результатов.
Описание API в Swagger¶
Описание REST API в формате OpenAPI (Swagger UI) доступно по адресу /api/docs относительно базового URL развёрнутой системы.
В интерфейсе Swagger UI можно:
- ознакомиться со списком эндпоинтов и их параметрами;
- посмотреть схемы запросов и ответов;
- выполнить тестовые запросы непосредственно из браузера.
Аутентификация¶
Все запросы к API (за исключением технических эндпоинтов проверки доступности) требуют валидного JWT-токена в заголовке:
JWT-токен получается через интеграцию с провайдером идентификации (Keycloak).