Cloud Networking Management

Nebula Control Center

V září 2021 společnost Zyxel Networks spolu s verzí P12 platformy Nebula představila také první verzi rozhraní Nebula OpenAPI určeného k přímé interakci softwaru s touto cloudovou platformou a se zařízeními, která jsou pomocí ní spravována. S rozhraním API mohou uživatelé platformy Nebula provádět správu sítí Nebula pomocí vlastních aplikací. Na této stránce najdete všechny důležité informace a často kladené dotazy k rozhraní Nebula OpenAPI.

Přehled rozhraní Nebula OpenAPI
  • Zyxel Nebula API je RESTful rozhraní chráněné protokolem HTTPS.
  • Zyxel Nebula API k autentizaci místo standardu OAUTH2 používá API klíč.
  • API klíč je určen pro správce a sdílí stejná oprávnění.
  • Bližší představení rozhraní Zyxel Nebula OpenAPI najdete​ zde.
Seznam podporovaných API

Nejnovější verzi rozhraní najdete zde. Nejnovější verzí k dnešnímu dni je verze 0.1.25.

FAQ
Nezbytné podmínky:

Ověřte, že vaše zařízení kompatibilní s platformou Nebula jsou registrována pod organizací, která má licenci Nebula Professional Pack. Upozorňujeme, že integrace rozhraní Nebula OpenAPI je možná pouze v případě licenčního balíčku Pro Pack.

Použití API klíče prostřednictvím ticketu/případu podpory:

Rozhraní Nebula OpenAPI zatím prochází ranou fází a neustálým vývojem, a proto doposud není obecně dostupné. Abychom vám v této fázi mohli být nápomocni, doporučujeme kontaktovat místní nebo regionální pobočku společnosti Zyxel nebo přímo Centrum nápovědy v rámci řídicího centra NCC a poté za účelem použití API klíče vytvořit ticket/případ podpory. V této souvislosti nezapomeňte prosím uvést nezbytné údaje.

  • Hlavní kontaktní okno pro registrovaný účet Zyxel.
  • Jaká rozhraní API chcete vyzkoušet a informace o vámi vytvořených aplikacích.

Email s ticketem/případem přepošlete místní pobočce společnosti Zyxel, která vaši žádost ověří z hlediska dopadu na organizaci. Náš tým pro správu platformy Nebula na základě těchto informací určí prioritu vaší žádosti.

Než začnete, ujistěte se, že máte k dispozici:

  1. APP nástroj, jako např. Postman.
  2. API klíč.
Jak postupovat:
  1. Navštivte webové stránky nástrojePostman, zaregistrujte se a vytvořte si účet.
  2. Po úspěšném přihlášení přejděte do sekce My workspace (Můj pracovní prostor). Pokud pracovní prostor ještě nemáte, vytvořte ho.
  3. V pracovním prostoru klikněte na tlačítko +, které se obvykle nachází v levém horním rohu rozhraní.
  4. Přejděte do sekce Headers (Záhlaví). V této sekci jsou dva sloupce označené jako Key (Klíč) a Value (Hodnota). Do pole Key zadejte "X-ZyxelNebula-API-Key". Poté do příslušného pole Value vložte API klíč, který jste obdrželi od našeho oddělení podpory.
    Upozornění: API klíč je propojen s vaším účtem a poskytuje přístup do vaší organizace, a proto ho uložte na bezpečném místě, kde nehrozí jeho vyzrazení. Pokud máte v souvislosti s API klíčem jakékoliv obavy o bezpečnost, vyžádejte si od našeho oddělení podpory nový klíč a původní klíč deaktivujte.
  5. Vložte adresu URL koncového bodu API: https://api.nebula.zyxel.com/v1/nebula. Po zadání adresy URL koncového bodu uveďte konkrétní údaje, které chcete získat. Příklad: pokud chcete získat např. následující údaje o organizaci:
    1. Nane: název organizace
    2. OrgId: jedinečné ID organizace
    3. Mode: licenční režim organizace

    Měla by upravená adresa URL vypadat následovně: https://api.nebula.zyxel.com/v1/nebula/organizations

    Pro provedení požadavku nakonec klikněte na tlačítko Send (Odeslat).

    Výsledky v odpovědi budou uvedeny v následujícím formátu:

API token, který najdete v menuSite-wide > Configure > Site settings se konkrétně používá ke generování API tokenu pro integraci klíčeDPPSK třetí stranou.

Bližší informace o řešení DPPSK pro platformu Nebula a o jeho integraci do systému třetí strany pro správu přístupu zařízení do sítě WiFi najdete na našich webovýchstránkách.