Справочное руководство OpenAPI
Справочное руководство OpenAPI предназначено для решения следующих задач:
- Автоматизация и настройка. Вы можете автоматизировать задачи, которые, возможно, не хотите выполнять вручную. Например, как администратор вы можете использовать OpenAPI для создания и запуска сценариев, которые упростят разработку структуры групп администрирования и поддержат ее в актуальном состоянии.
- Пользовательская разработка. Используя OpenAPI, вы можете разработать клиентское приложение.
Вы можете использовать поле поиска в правой части экрана, чтобы найти нужную информацию в справочном руководстве OpenAPI.
Справочное руководство OpenAPI
Примеры сценариев
Справочное руководство по OpenAPI содержит примеры сценариев Python, перечисленные в таблице ниже. Примеры показывают, как вы можете вызывать методы OpenAPI и автоматически выполнять различные задачи по защите вашей сети, например, создавать иерархию "главный/подчиненный", запускать задачи в Open Single Management Platform или назначать точки распространения. Вы можете запускать примеры как есть или создавать собственные сценарии на их основе.
Сопоставление пользовательских сценариев и примеров методов OpenAPI
Пример | Назначение примера | Сценарий |
|---|---|---|
Вы можете извлекать и обрабатывать данные, используя Пример вывода может быть представлен по-разному. Вы можете получить данные для отправки HTTP-метода или использовать их в своем коде. | ||
Вы можете добавить подчиненный Сервер администрирования и установить таким образом отношение иерархии "главный Сервер – подчиненный Сервер". Или вы можете исключить подчиненный Сервер администрирования из иерархии. | Создание иерархии Серверов администрирования: добавление подчиненного Сервера администрирования и удаление иерархии Серверов администрирования | |
Загрузите файлы списка сетей с помощью шлюза соединения на указанное устройство | Вы можете подключиться к Агенту администрирования на нужном устройстве, используя шлюз соединения, а затем загрузить файл со списком сетей на свой компьютер. | |
Вы можете подключиться к главному Серверу администрирования, загрузить с него необходимый лицензионный ключ и передать этот ключ на все подчиненные Серверы администрирования, входящие в иерархию. | Лицензирование управляемых приложений | |
Вы можете создать разные отчеты. Например, вы можете сгенерировать отчет об эффективных правах пользователя, используя этот пример. В этом отчете представлена информация о правах, которыми обладает пользователь в зависимости от его группы и роли. Вы можете загрузить отчет в формате HTML, PDF или Excel. | ||
Вы можете подключиться к Агенту администрирования на нужном устройстве, используя шлюз соединения, а затем запустить необходимую задачу. | ||
Вы можете назначить управляемые устройства точками распространения (ранее они назывались "агенты обновлений"). | ||
|
| Вы можете выполнять различные действия с группами администрирования. В примере показано, как выполнить следующее:
| |
Вы можете ознакомиться со следующей информацией:
Вы также можете запустить задачу. По умолчанию пример запускает задачу после вывода статистики. | ||
Вы можете создать задачу. Укажите в примере следующие параметры задачи:
По умолчанию в примере создается задача типа "Показать сообщение". Вы можете запустить эту задачу для всех управляемых устройств Сервера администрирования. При необходимости вы можете указать свои параметры задачи. | ||
Вы можете получить список всех активных лицензионных ключей для приложений "Лаборатории Касперского", установленных на управляемых устройствах Сервера администрирования. Список содержит подробные сведения о каждом лицензионном ключе, такие как имя, тип или срок действия. | ||
Вы можете создать категорию приложений с требуемыми параметрами. | ||
Вы можете использовать класс SrvView для запроса подробной информации с Сервера администрирования. Например, вы можете получить список пользователей, используя этот пример. |
Приложения, взаимодействующие с Open Single Management Platform через OpenAPI
Некоторые приложения взаимодействуют с Open Single Management Platform через OpenAPI. К таким приложениям относятся, например, Kaspersky Anti Targeted Attack Platform. Это также может быть пользовательское клиентское приложение, разработанное вами на основе OpenAPI.
Приложения, взаимодействующие с Open Single Management Platform через OpenAPI, подключаются к Серверу администрирования. Чтобы узнать, работает ли используемое вами приложение с OpenAPI, обратитесь к справке этого приложения.
