Nebula 雲端管理平台(NCC)

Nebula Control Center

在2021年9月，隨著 P12 的釋出，Nebula 引入了 Nebula 開放 API 的初始版本，該版本作為軟體與Nebula 雲端平台和 Nebula 管理的設備直接互動的介面。這些 API 使 Nebula 用戶能夠通過自定義開發的應用程式，以程式化的方式管理 Nebula。本頁面提供關於 Zyxel Nebula 開放 API 的概述和常見問題。

Zyxel Nebula 開放 API 概述
  • Zyxel Nebula API 是 RESTful 並且受到 HTTPS 保護。
  • Zyxel Nebula API 使用 API 金鑰而不是 OAuth2 進行驗證。
  • API 金鑰的範圍包含每位管理員，並且它分享相同的權限。
  • 關於更多入門的 Zyxel Nebula 開放 API 介紹，請閱讀 這個。
支援的 API 清單

您可以在 這裡 找到最新版本，目前最新版本為 0.1.30。

常見問題
先決條件：

確保您的 Nebula 設備在 Nebula Professional Pack 許可組織下註冊，因為 Nebula OpenAPI 集成僅在 Pro Pack 中提供。

隨著 Nebula 18.20 的發佈，合勤大大簡化了 API 金鑰管理流程，使其使用者友好、更快、更安全。用戶現在可以直接從 NCC 生成和重新生成 API 金鑰。要生成新的 API 金鑰，請登錄 NCC，然後轉到“我的設備和服務”下的“API 金鑰管理”。然後按照提示生成、確認安全措施、複製並保存您的金鑰。

請將您的需求Email 給當地的 Zyxel 業務或業務工程師，我們將就功能需求對您業務的影響進行驗證。這將有助於Nebula 產品管理團隊確定您的需求的優先序。

在開始之前，請確保您有下列工具與符合相關要求：

  1. 應用程式工具，例如 Postman。
  2. API 金鑰。
程序：
  1. 前往 Postman 網站並註冊建立帳戶。
  2. 登入成功後，前往「我的工作區」(My workspace)。如果您還沒有工作區，您可以建立一個新的。
  3. 在工作區內，找到位於介面左上角的「+」按鈕，點擊以繼續下一步驟。
  4. 找到「表頭」(Headers)部分。在這個部分內，您會看到兩列分別標記為「鍵」(Key)和「值」(Value)。在「鍵」欄位中，輸入「X-ZyxelNebula-API-Key」。然後，在相對應的「值」欄位中，貼上您從Zyxel客服取得的 API 金鑰。
    提醒： API 金鑰與您的帳戶綁定，因此務必保持金鑰的安全和保密，因為它提供了對您組織的訪問權限。如果您對您的 API 金鑰有任何安全疑慮，請聯繫 Zyxel 客服請求新的 API 金鑰並停用舊的金鑰。
  5. 輸入 API 端點：https://api.nebula.zyxel.com/v1/nebula。加入端點 URL 後，請包含您希望取得的特定訊息。如果您想獲取組織的詳細信息，例如：
    1. 名稱：組織的名稱
    2. 組織ID：組織的唯一ID
    3. 模式：組織的方案模式

    修改後的 URL 應該如下所示：https://api.nebula.zyxel.com/v1/nebula/organizations

    最後，點擊「發送」(Send)按鈕以執行需求。

    回應將以以下格式呈現結果：

位於 「全站點(Site-wide) > 設定(Configure) > 站點設置(Site settings)」 的 API token 專門用於生成 DPPSK 第三方整合的 API token。

若想更多了解 Nebula 的 DPPSK 解決方案以及如何將其與第三方 WiFi 上線管理系統整合，請瀏覽 我們的網站。