Cloud Networking Management

Nebula Control Center

We wrześniu 2021 roku, wraz z wydaniem P12, Nebula wprowadziła wstępną wersję Nebula OpenAPI, która służy jako interfejs dla oprogramowania do bezpośredniej interakcji z platformą chmurową Nebula i urządzeniami zarządzanymi przez Nebula. Te API umożliwiają użytkownikom Nebula programowe zarządzanie sieciami Nebula na dużą skalę za pomocą niestandardowych aplikacji. Ta strona służy jako dokument przeglądowy i FAQ dla Zyxel Nebula OpenAPI.

Przegląd Nebula OpenAPI
  • Interfejs API Zyxel Nebula działa w trybie RESTful i jest zabezpieczony protokołem HTTPS.
  • Zyxel Nebula API używa klucza API zamiast OAUTH2 do uwierzytelniania.
  • Zakres klucza API jest przypisany do administratora i ma te same uprawnienia.
  • Aby uzyskać bardziej podstawowe wprowadzenie do Zyxel Nebula OpenAPI, przeczytaj to.
Lista obsługiwanych API

Najnowszą wersję można znaleźć tutaj, a obecnie najnowsza wersja to 0.1.25

FAQ
Wymagania wstępne:

Upewnij się, że Twoje urządzenia Nebula są zarejestrowane w organizacji licencjonowanej przez Nebula Professional Pack. Należy pamiętać, że integracja Nebula OpenAPI jest funkcją dostępną wyłącznie w pakiecie Pro.

Wnioskowanie o klucz API za pośrednictwem zgłoszenia / sprawy pomocy technicznej:

Ponieważ Nebula OpenAPI jest wciąż na wczesnym etapie rozwoju i stale ewoluuje, nie jest jeszcze ogólnie dostępna. Aby zapewnić lepsze wsparcie podczas tego procesu, zalecamy skontaktowanie się z lokalnym / regionalnym biurem Zyxel lub bezpośredni dostęp do Centrum pomocy NCC w celu utworzenia zgłoszenia / sprawy dotyczącej zastosowania klucza API. Prosimy o podanie niezbędnych informacji.

  • Główny kontakt z zarejestrowanym kontem Zyxel.
  • Z których interfejsów API zamierzasz skorzystać i informacje o tworzonych aplikacjach.

Prześlij zgłoszenie / wiadomość e-mail do lokalnego działu sprzedaży Zyxel lub inżyniera sprzedaży, aby zweryfikować żądanie funkcji pod kątem jej wpływu na biznes. Pomoże to zespołowi zarządzania produktem Nebula w określeniu priorytetu żądania.

Zanim rozpoczniesz, upewnij się, że spełniasz następujące wymagania:

  1. Narzędzie API, takie jak​Postman.
  2. Klucz API.
Procedura:
  1. Przejdź na stronę Postman i zarejestruj się, aby utworzyć konto.
  2. Po pomyślnym zalogowaniu przejdź do sekcji „Mój obszar roboczy". Jeśli nie masz obszaru roboczego, możesz utworzyć nowy.
  3. W obszarze roboczym znajdź przycisk „+" zwykle znajdujący się w lewym górnym rogu interfejsu i kliknij go, aby kontynuować.
  4. 4. Znajdź sekcję „Nagłówki". W tej sekcji zobaczysz dwie kolumny z etykietami „Klucz" i „Wartość". W polu „Klucz" wprowadź „X-ZyxelNebula-API-Key". Następnie w odpowiednim polu „Wartość" wklej klucz API otrzymany od pomocy technicznej Zyxel.
    Przypomnienie: Klucz API jest powiązany z Twoim kontem, więc ważne jest, aby go zabezpieczyć i zachować poufność, ponieważ zapewnia dostęp do Twojej organizacji. Jeśli masz jakiekolwiek wątpliwości dotyczące bezpieczeństwa Twojego klucza API, nie wahaj się skontaktować z pomocą techniczną Zyxel, aby poprosić o nowy klucz API i dezaktywować stary.
  5. Wstaw URL punktu końcowego API: https://api.nebula.zyxel.com/v1/nebula. Po dodaniu adresu URL punktu końcowego dołącz konkretne informacje, które chcesz pobrać. Na przykład, jeśli chcesz uzyskać szczegóły organizacji, takie jak:
    1. Nazwa: nazwa organizacji
    2. OrgId: unikalny identyfikator organizacji
    3. Tryb: tryb licencji organizacji

    Zmodyfikowany adres URL powinien wyglądać następująco: https://api.nebula.zyxel.com/v1/nebula/organizations

    Na koniec kliknij przycisk „Wyślij", aby wykonać żądanie.

    Odpowiedź przedstawi wyniki w następującym formacie:

Token API, który znajduje się w zakładce Site-wide > Configure > Site settings, jest specjalnie używany do generowania tokena API dla integracji DPPSK z innymi podmiotami.

Aby dowiedzieć się więcej o rozwiązaniu DPPSK firmy Nebula i o tym, jak zintegrować je z zewnętrznym systemem zarządzania onboardingiem WiFi, odwiedź naszą stronę internetową..