Аналитика и отчёты

SecuReporter

Открытый API для SecuReporter

Автоматизация и быстрое создание специально разработанных приложений с помощью открытого API для платформы SecuReporter.

Доступ к данным устройства с помощью SecuReporter OpenAPI

SecuReporter поддерживает интерфейс API для прямого взаимодействия с облачной платформой.
Он позволяет получать логи устройств за последний месяц с помощью токена API.

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

Откройте для себя максимальные преимущества OpenAPI SecuReporter

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

Удобство и эффективность

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

Масштабируемость

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

Возможность автоматизации

Беспрепятственная интеграция с другими системами и программным обеспечением с помощью токенов API. Автоматизируйте получение логов межсетевых экранов и включите эти данные в свои системы управления информацией (SIEM) без ручного вмешательства.

Интеграция OpenAPI SecuReporter

SecuReporter предоставляет безопасный, эффективный и удобный метод доступа к логам межсетевых экранов. Поддерживайте как ручные, так и автоматизированные процессы, сохраняя при этом высокие стандарты безопасности. Для получения более подробной информации об интеграции SecuReporter OpenAPI и многом другом посетите наш GitHub.

Zyxel GitHub

Часто задаваемые вопросы

Пока вы изучаете, как интегрировать OpenAPI с SecuReporter, вот несколько полезных советов и часто задаваемых вопросов, которые помогут вам.

Сервис архивных логов — это первый открытый сервис, предлагаемый SecuReporter OpenAPI. Он позволяет получать логи межсетевых экранов за период до 31 дня с использованием токена API. Каждый токен API предоставляет максимум 50 запросов в час. Следите за новостями о новых сервисах, которые будут реализованы в будущем.

Отправьте запрос в техническую поддержку Zyxel, чтобы мы смогли подтвердить его.

Условия:

Убедитесь, что на вашем межсетевом экране имеется активная лицензия SecuReporter и что сам сервис включен. Если срок действия лицензии истек, приобретите новую для доступа к OpenAPI.

Инструкция по созданию токена OpenAPI в SecuReporter:

Шаг 1: Выберите устройство с активной лицензией SecuReporter и нажмите кнопку «API Access».

Шаг 2: Нажмите кнопку "Create New API Token".

Шаг 3: Скопируйте токен OpenAPI.

Для тестирования OpenAPI предусмотрены два метода: cURL и Python.

[1] Тестирование с помощью cURL

  • Чтобы проверить, установлен ли cURL, откройте командную строку или терминал и введите сurl. Если вы получили сообщение, что cURL не найден, следуйте инструкциям по установке, доступным в репозитории cURL GitHub.
  • Для выполнение первого запроса OpenAPI откройте командную строку/терминал и используйте нижеуказанные команды. Замените yyyy-MM-dd датой в течение последних 31 дней (кроме текущего дня), используя формат гггг-мм-дд. Замените mydir указанием фактического пути к папке загрузок на вашем компьютере.

macOS

curl -X POST \

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \

-H "Content-Type: application/json" \

-H "X-Authorization: Bearer $OPEN_API_TOKEN" \

-d "{\"device_date\":\"yyyy-MM-dd\"}" \

-o mydir/archive.tar

Windows

curl -X POST ^

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^

-H "Content-Type: application/json" ^

-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^

-d "{\"device_date\":\"yyyy-MM-dd\"}" ^

-o mydir\archive.tar

Замените "https://api.example.com/endpoint" фактической конечной точкой API и "your_api_token" своим токеном API.

[2] Тестирование с помощью Python

  • Чтобы проверить, установлен ли Python, откройте командную строку или терминал и введите ‘python’. Если вы получили сообщение, что Python не найден, следуйте инструкциям по установке, доступным на официальном сайте Python. Для использования библиотеки Requests убедитесь, что у вас установлен Python 3.8 или новее.
  • Создайте и активируйте виртуальное окружение (Virtual Environment): следуйте официальной документации Python venv для создания виртуального окружения в каталоге проекта.

macOS

source your-virtual-environment-path/bin/activate

Windows

your-virtual-environment-path\Scripts\activate

Замените your-virtual-environment-path фактическим путем к каталогу виртуального окружения.

Каждая площадка генерирует один токен API, который может использоваться несколькими системами или приложениями. Однако существует ограничение на использование для каждого токена API (50 запросов в час).