Работа со структурой API¶

Данная инструкция описывает работу со структурой API, построенной модулем ПроAPI Структура.

Построенная структура API отображается в секции ПроAPI Структура. Секция доступна только пользователям со следующими ролями:

• Администратор и Аналитик могут управлять данными, обнаруженными модулем ПроAPI Структура.

  Глобальный администратор и Глобальный аналитик в аккаунтах с опцией мультиарендности имеют такие же права.

• Разработчик API может просматривать и скачивать структуру API, построенную модулем ПроAPI Структура. Эта роль позволяет выделить пользователей, которым для решения рабочих задач необходимо иметь актуальную структуру API компании. Пользователи имеют доступ только к секциям ПроAPI Структура и Настройки → Профиль.

ПроAPI Структура отображается в привычном виде, подобном Swagger UI, и состоит из следующих элементов:

• Клиентские приложения и хосты API.

• Эндпоинты, сгруппированные по хостам API. Для каждого эндпоинта отображается HTTP-метод.

Фильтрация эндпоинтов¶

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

• Эндпоинты, которые были изменены или обнаружены за последнюю неделю и которые обрабатывают чувствительные данные. Подобные выборки помогают вам оставаться в курсе важных изменений в ваших API.

• Эндпоинты, которые используются для загрузки данных на ваш сервер (с помощью фильтра по методам API). Такие эндпоинты — частая цель атак, поэтому должны находиться под защитой. Получив выборку, вы сможете проверить, что все эндпоинты известны вам и защищены.

• Эндпоинты, в которых передаются банковские данные ваших клиентов. Подобная выборка позволит вам проверить, что чувствительные данные передаются на корректные эндпоинты, или обнаружить новые эндпоинты, обрабатывающие чувствительные данные. Такие эндпоинты также частая цель атак, поэтому должны быть известны и находиться под защитой.

• Запросить эндпоинты устаревшей версии API (например, поиск по /v1) и убедиться, что они больше не используются клиентами.

Вы также можете выгрузить отфильтрованные эндпоинты в формате OpenAPI v3 для дополнительного анализа.

Просмотр параметров эндпоинта¶

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

Для сортировки нажмите имя колонки. Для смены направления сортировки нажмите еще раз.

Для каждого параметра приведена следующая информация:

• Имя параметра и часть запроса, в которой он передается

• Наличие и тип чувствительных данных в параметре, включая:

  • Технические данные, например: IP-адрес или MAC-адрес
  • Учетные данные, например: секретный ключ или пароль
  • Финансовые данные, например: номер банковской карты
  • Медицинские данные, например: номер страховки
  • Персональные данные (PII), например: ФИО, номер паспорта или водительского удостоверения

• Дата и время последнего обновления информации о параметре

• Тип/формат данных, которые передаются в этом параметре

Отслеживание изменений в структуре API¶

Вы можете проверить, какие изменения произошли в структуре API в течение выбранного отрезка времени. Для этого в фильтре Изменения с укажите нужный отрезок времени. В списке эндпоинтов появятся отметки:

• Новый для эндпоинтов, добавленных в структуру в выбранном отрезке времени.

• Изменен для эндпоинтов, у которых есть новые или удаленные параметры. Параметры будут иметь соответствующую отметку.

• Удален для эндпоинтов, к которым не было обращений в течение определенного периода. Для каждого эндпоинта этот период определяется отдельно - вычисляется на основе статистики доступа к данному эндпоинту. Если на ранее удаленный эндпоинт снова поступают запросы, он отмечается как "новый".

Использование фильтра Изменения с только подсвечивает измененные эндпоинты среди остальных. Если вы хотите видеть только измененные эндпоинты и скрыть остальные, выберите один или несколько типов изменений в фильтре Изменения в структуре API:

• Новые эндпоинты

• Измененные эндпоинты

• Удаленные эндпоинты

При выборе значений в списке будут показаны только эндпоинты с соответствующими изменениями в выбранном отрезке времени.

ПроAPI Структура и связанные события¶

Чтобы увидеть данные об атаках и инцидентах за последние 7 дней для какого-либо эндпоинта, в меню этого эндпоинта выберите Поиск атак по эндпоинту:

Отобразится секция События с примененным фильтром:

attacks incidents last 7 days d:<YOUR_API_HOST> u:<YOUR_ENDPOINT>

Вы также можете скопировать URL какого-либо эндпоинта в буфер обмена и использовать его для поиска событий. Для этого в меню этого эндпоинта выберите Скопировать URL.

ПроAPI Структура и правила¶

Вы можете быстро создать новое индивидуальное правило из строки любого эндпоинта в структуре API:

1. В меню нужного эндпоинта выберите Создать правило. Появится окно создания правила. В окне адрес эндпоинта будет автоматически разбит на компоненты.

2. В окне создания правила выберите правило, задайте его параметры и нажмите Создать.

Скачивание спецификации OpenAPI (OAS) вашей структуры API¶

Нажмите Скачать OAS чтобы скачать файл swagger.json с описанием структуры вашего API, обнаруженной Вебмониторэкс. Формат описания в файле - OpenAPI v3.

Анализ скачанных данных позволяет обнаружить:

• Список эндпоинтов, обнаруженных Вебмониторэкс, но отсутствующих в вашей спецификации (недостающие эндпоинты, так называемый "Shadow API").

• Список эндпоинтов, присутствующих в вашей спецификации, но не обнаруженных Вебмониторэкс (неиспользуемые эндпоинты, так называемый "Orphan API").