Использование Kaspersky Industrial CyberSecurity for Networks API
В Kaspersky Industrial CyberSecurity for Networks реализован интерфейс прикладного программирования (Application Programming Interface, далее API), который обеспечивает доступ к функциям программы для сторонних приложений.
В комплект поставки Kaspersky Industrial CyberSecurity for Networks входит пакет с описаниями спецификаций для представления данных в запросах к серверу REST API. Сервер REST API функционирует на компьютере Сервера Kaspersky Industrial CyberSecurity for Networks и обрабатывает запросы с использованием архитектурного стиля взаимодействия REST (Representational State Transfer). Обращения к серверу REST API выполняются по протоколу HTTPS. Вы можете настроить параметры сервера REST API в разделе Параметры → Серверы подключений (в том числе заменить используемый по умолчанию самоподписанный сертификат на доверенный).
Для представления данных в запросах и ответах используется формат JSON.
Документация с описанием запросов на основе архитектурного стиля REST публикуется в виде онлайн-справки на странице Kaspersky Online Help. Документация представляет собой руководство разработчика на английском языке. В руководстве разработчика также представлены примеры кода и подробные описания вызываемых элементов, которые доступны в запросах к серверу REST API.
ОТКРЫТЬ ДОКУМЕНТАЦИЮ С ОПИСАНИЕМ ЗАПРОСОВ К СЕРВЕРУ REST API, версия 3
ОТКРЫТЬ ДОКУМЕНТАЦИЮ С ОПИСАНИЕМ ЗАПРОСОВ К СЕРВЕРУ REST API, версия 4
С помощью Kaspersky Industrial CyberSecurity for Networks API сторонние приложения могут выполнять следующие действия:
- получать данные об известных программе устройствах;
- добавлять, изменять и удалять устройства;
- получать данные о зарегистрированных событиях;
- отправлять события в Kaspersky Industrial CyberSecurity for Networks (для регистрации используется системный тип события с кодом 4000005400);
- получать данные о списке тегов и о параметрах тегов;
- подписываться на уведомления о полученных значениях тегов;
- получать данные об обнаруженных уязвимостях;
- получать сообщения программы и записи аудита;
- получать данные о разрешающих правилах;
- включать, выключать и удалять разрешающие правила;
- получать данные о рисках, связанных с устройствами;
- получать данные об адресных пространствах;
- отправлять отчет о топологической карте сети в Kaspersky Industrial CyberSecurity for Networks;
- получать следующие данные о программе:
- список узлов с установленными компонентами программы;
- список точек мониторинга и их параметры;
- список поддерживаемых стеков протоколов и их параметры;
- список типов событий и их параметры;
- текущее состояние и режимы работы технологий;
- версия программы и даты выпуска установленных обновлений;
- информация о добавленном лицензионном ключе;
- язык локализации программы.
Все перечисленные действия доступны при выполнении запросов к серверу REST API версии 4. При выполнении запросов к серверу REST API версии 3 некоторые действия не поддерживаются.
Сторонние приложения, использующие Kaspersky Industrial CyberSecurity for Networks API, подключаются к Серверу программы через коннекторы. Коннекторы обеспечивают безопасное соединение с использованием сертификатов. Для каждого стороннего приложения, из которого вы хотите отправлять запросы на сервер REST API, вам нужно создать отдельный коннектор в Kaspersky Industrial CyberSecurity for Networks.
Для соединения с Kaspersky Industrial CyberSecurity for Networks стороннее приложение должно использовать токен аутентификации. Программа выдает токен аутентификации по запросу стороннего приложения и использует для токена сертификаты коннектора, который был создан для этого стороннего приложения. Время действия токена аутентификации составляет 10 часов. Стороннее приложение может обновить токен аутентификации по специальному запросу.
Документация с описанием запросов для выполнения действий с токеном аутентификации публикуется в виде онлайн-справки на странице Kaspersky Online Help. Документация представляет собой руководство разработчика на английском языке.
ОТКРЫТЬ ДОКУМЕНТАЦИЮ С ОПИСАНИЕМ ЗАПРОСОВ ДЛЯ ДЕЙСТВИЙ С ТОКЕНОМ АУТЕНТИФИКАЦИИ, версия 3
ОТКРЫТЬ ДОКУМЕНТАЦИЮ С ОПИСАНИЕМ ЗАПРОСОВ ДЛЯ ДЕЙСТВИЙ С ТОКЕНОМ АУТЕНТИФИКАЦИИ, версия 4
В Kaspersky Industrial CyberSecurity for Networks API предусмотрены следующие способы работы со сторонними приложениями:
- взаимодействие на основе архитектурного стиля REST;
- взаимодействие по протоколу WebSocket.
Сторонние приложения могут использовать способ взаимодействия по протоколу WebSocket в Kaspersky Industrial CyberSecurity for Networks API для создания подписок на изменяемые значения, которые получает программа. Например, этот способ взаимодействия позволяет подписываться на уведомления о полученных значениях определенного тега.
