Начало работы¶

Эта инструкция поможет быстро начать работу с платформой: от первого входа до получения данных на дашборде и включения защиты.

Подготовка к работе¶

Убедитесь, что у вас есть учетные данные (логин и пароль) для доступа к платформе.
Проверьте доступ настройкам сетевой маршрутизации (iptables, reverse proxy, DNS) для направления трафика API через ноду.
Подготовьте файл спецификации в формате OpenAPI (JSON/YAML) – для сценария со спецификацией.

Приветственное сообщение на дашборде¶

При первом входе открывается страница «Аналитика угроз ПроAPI Защита» → вкладка Дашборд.
Если данные ещё не поступали, отображается карточка:

Добро пожаловать на борт.

Кажется, вы только начали использовать платформу, поэтому данные еще не поступили. Для старта работы добавьте ноду и подождите, чтобы данные доехали до нас.

В этом сообщении предлагаются два сценария:

«У меня нет спецификации и/или я хочу проанализировать трафик» → + Создать ноду
«У меня есть спецификация и я хочу сразу защищать мои приложения в режиме мониторинга или блокировки» → + Создать приложение

Сценарии начала работы¶

Сценарий 1: У меня нет спецификации → анализ трафика¶

Используйте этот сценарий, чтобы обнаружить актуальную структуру API – спецификацию можно загрузить позже.

Нажмите + Создать ноду
Система предложит создать ноду, следуйте инструкциям раздела Ноды.
После создания ноды система автоматически связывает с ней дефолтное приложение (имя приложения — default). Это приложение нельзя удалить, но его можно переименовать и редактировать. При этом:
- Режим защиты этого приложения установлен в «выключено» (off).
- Инвентаризация (анализ трафика) включена.
- Спецификация не загружена.
Направьте трафик через ноду.
Перейдите в раздел Структура API для просмотра собранной структуры.

Сценарий 2: У меня есть спецификация → защита в режиме мониторинга или блокировки¶

Используйте этот сценарий, если спецификация OpenAPI уже готова и нужно сразу начать валидацию запросов.

Нажмите + Создать приложение
Создайте приложение, загрузите файл спецификации OpenAPI.
Выберите режим защиты:
- Мониторинг (monitoring) — только логирование нарушений, запросы и ответы не блокируются.
- Блокировка (block) — логирование нарушений, запросы и ответы блокируются.
Для режима мониторинг можно дополнительно включить инвентаризацию (анализ структуры API).
- Если инвентаризация включена, система собирает данные обо всех проходящих запросах и отображает их в разделе Структура API. Это позволяет выявлять Shadow API и недокументированные эндпоинты даже при работающей валидации.
- По умолчанию инвентаризация в режиме мониторинга включена. Чтобы отключить её, снимите флажок Инвентаризация.
- Примечание: в режиме блокировка инвентаризация обычно не требуется – невалидные запросы отклоняются и не достигают бэкенда.
Создайте ноду. Следуйте инструкциям раздела Ноды.
Направьте трафик через ноду.

Все события нарушений автоматически регистрируются в разделе События.