Централизованное управление

Nebula

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

Обзор
  • Nebula API представляет собой RESTful API с поддержкой HTTPS.
  • Nebula API для аутентификации использует ключ API вместо OAUTH2.
  • Ключ API уникален для каждого администратора.
  • Более подробную информацию можно найти здесь.
Документация API

Последнюю документацию можно найти на этой странице, и на данный момент самая последняя версия — 0.1.25.

Часто задаваемые вопросы
Условия:

Убедитесь, что ваши устройства Nebula зарегистрированы в организации проф. версии (Pro Pack).
Важно отметить, что доступ к API — это функция, доступная исключительно в проф. версии Nebula.

Получение ключа API через заявку в службу поддержки:

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

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

Создайте обращение в техподдержку Zyxel с подробным описанием требуемых функций. Команда управления продуктами Nebula позже определит возможность расширения функционала API.

Прежде чем начать, убедитесь, что у вас есть:

  1. Доступ к сервису для обслуживания API, например Postman.
  2. Ключ API.
Порядок действий:
  1. Откройте сайт Postman и создайте аккаунт, если его ещё нет.
  2. После авторизации откройте рабочее пространство ("My workspace"). Если у вас нет рабочего пространства, вы можете создать новое.
  3. Найдите кнопку «+», которая обычно находится в левом верхнем углу интерфейса, и нажмите ее, чтобы продолжить.
  4. Откройте раздел "Headers". Внутри этого раздела вы увидите два столбца: "Key" и "Value". В строке "Key" введите "X-ZyxelNebula-API-Key".
    Затем вставьте в строку "Value" ключ API, полученный от техподдержки Zyxel.
    Напоминание: Ключ API привязан к вашему аккаунту, поэтому очень важно обеспечить его конфиденциальность, так как он обеспечивает доступ к вашей организации. Если у вас есть какие-либо проблемы с безопасностью ключа API, обращайтесь в службу поддержки Zyxel, чтобы запросить новый ключ и деактивировать старый.
  5. Вставьте начальный URL-адрес API: https://api.nebula.zyxel.com/v1/nebula. Затем укажите конкретную информацию, которую вы хотите получить. Например, если вы хотите получить сведения об организации, такие как:
    1. Name: название организации
    2. OrgId: идентификатор организации
    3. Mode: версия организации
    то полный URL будет следующим: https://api.nebula.zyxel.com/v1/nebula/organizations

    Наконец, нажмите кнопку «Send», чтобы выполнить запрос.

    В ответе будут представлены результаты в следующем формате:

Токен API, расположенный в меню Конфигурация > Настройки площадки, используется только с Wi-Fi авторизацией DPPSK для интеграции с внешними сервисами. К открытому API он не имеет отношения.

Чтобы узнать больше о решении Nebula DPPSK и о том, как его интегрировать с внешними сервисами, откройте эту страницу.