Cloud Networking Management

Nebula Control Center

2021 szeptemberében, a P12 kiadása mellett, a Nebula bemutatta a Nebula OpenAPI kezdeti verzióját, amely interfészként szolgál a szoftverek számára, amelyek így közvetlenül kommunikálhatnak a Nebula felhőplatformmal és a Nebula által felügyelt eszközökkel. Ezek az API-k lehetővé teszik a Nebula felhasználók számára a Nebula hálózatok programozott, skálázható kezelését, egyedi fejlesztésű alkalmazásokon keresztül. Ez az oldal a Zyxel Nebula OpenAPI áttekintése és GYIK dokumentumaként szolgál.

Nebula OpenAPI áttekintése
  • A Zyxel Nebula API RESTful és HTTPS-védett.
  • A Zyxel Nebula API API kulcsot használ az OAUTH2 helyett a hitelesítéshez.
  • Az API-kulcs hatóköre egy adott rendszergazdához tartozik, és ugyanazokkal az engedélyekkel rendelkezik.
  • A Zyxel Nebula OpenAPI alapszintű bemutatásához olvassa el ezt.
API Támogatási lista

A legújabb verziót itt találja, jelenleg a legújabb verzió a 0.1.26

GYIK
Előfeltétel:

Győződjön meg arról, hogy Nebula eszközeit egy Nebula Professional Csomag engedéllyel rendelkező szervezet regisztrálta. Fontos megjegyezni, hogy a Nebula OpenAPI integráció kizárólag a Pro Csomagban elérhető szolgáltatás.

API-kulcs alkalmazása támogatási ticketen/eseten keresztül:

Mivel a Nebula OpenAPI még korai szakaszban van, és folyamatosan fejlesztjük, még nem érhető el az általános közönség számára. A folyamat során nyújtott jobb támogatás érdekében javasoljuk, hogy lépjen kapcsolatba a helyi/regionális Zyxel-irodával, vagy lépjen kapcsolatba közvetlenül az NCC Súgóközponttal, és hozzon létre támogatási ticketet/esetet az API-kulcs alkalmazásához. Kérjük, hogy ennek során tüntesse fel a szükséges információkat.

  • A fő kapcsolatfelvételi ablak a regisztrált Zyxel fiókkal.
  • Milyen API-kat tervez kipróbálni, illetve a fejlesztendő alkalmazással kapcsolatos információk.

Kérjük, továbbítsa a ticket/ügy e-mailjét a helyi Zyxel értékesítőnek vagy értékesítési mérnöknek, hogy validálja funkcionális kérelmét a vállalkozásra gyakorolt hatás szempontjából. Ez segíteni fogja a Nebula termékmenedzsment csapatát a kérés prioritásának meghatározásában.

Mielőtt elkezdené, győződjön meg arról, hogy rendelkezésére állnak az alábbiak:

  1. APP tool, such as Postman.
  2. 2. API kulcs.
Eljárás:
  1. Nyissa meg a Postman webhelyet, és regisztráljon fiók létrehozásához.
  2. Sikeres bejelentkezés után lépjen a „Saját munkaterület” részre. Ha nincs munkaterülete, létrehozhat egy újat.
  3. A munkaterületen belül keresse meg a "+" gombot, amely általában a felület bal felső sarkában található, és kattintson rá a folytatáshoz.
  4. Keresse meg a „Fejlécek” részt. Ezen a szakaszon belül két oszlopot fog látni, amelyek "Kulcs" és "Érték" felirattal vannak ellátva. A "Kulcs" mezőbe írja be az "X-ZyxelNebula-API-Key" kifejezést. Ezután a megfelelő "Érték" mezőbe illessze be a Zyxel támogatási részlegétől kapott API-kulcsot.
    Emlékeztető: Az API-kulcs a fiókjához van kötve, ezért elengedhetetlen, hogy biztonságosan és bizalmasan kezelje, mivel hozzáférést biztosít a szervezetéhez. Ha bármilyen biztonsági aggálya van az API-kulccsal kapcsolatban, ne habozzon kapcsolatba lépni a Zyxel ügyfélszolgálatával, hogy új API-kulcsot kérjen, és inaktiválja a régit.
  5. Illessze be az API-végpont URL-jét: https://api.nebula.zyxel.com/v1/nebula.A végpont URL-címének hozzáadása után adja meg a lekérni kívánt konkrét információkat. Például, ha meg szeretné szerezni a szervezet adatait:
    1. a. Name: A szervezet neve
    2. OrgId: a szervezet egyedi azonosítója
    3. Mode: A szervezet licenc állapota

    A módosított URL-nek a következőképpen kell megjelennie:  https://api.nebula.zyxel.com/v1/nebula/organizations

    Végül kattintson a "Küldés" gombra a kérés végrehajtásához.

    A válasz a következő formátumban mutatja be az eredményeket:

Az API-token, amely a Webhely-szint > Konfigurálás > Webhelybeállítások részben található, kifejezetten egy API-token létrehozására szolgál a DPPSK  harmadik fél integrációjához

Ha többet szeretne megtudni a Nebula DPPSK-megoldásáról és arról, hogyan integrálhatja azt egy harmadik féltől származó WiFi onboarding felügyeleti rendszerrel, keresse fel webhelyünket..