Verwaltung und Berichterstattung

Cloud CNM SecuReporter

Zyxel SecuReporter OpenAPI

Hier finden Sie Ressourcen, die Ihnen helfen, mit APIs für die Zyxel SecuReporter-Plattform benutzerdefinierte Anwendungen zu automatisieren und schnell zu entwickeln.

Zugriff auf Gerätedaten mit dem SecuReporter OpenAPI-Dienst

SecuReporter unterstützt eine Schnittstelle, über die Software direkt mit der SecuReporter-Cloud-Plattform interagieren kann.
Diese APIs ermöglichen es SecuReporter-Benutzern, mithilfe eines API-Tokens Gerätelogdateien der letzten 31 Tage abzurufen.

Mit der SecuReporter OpenAPI können Sie über HTTP-Anfragen mit beliebigen Programmiersprachen oder cURL-Befehlen ganz einfach auf Ihre Gerätedaten zugreifen. Um diesen Dienst nutzen zu können, stellen Sie sicher, dass Ihr Gerät über eine gültige SecuReporter-Lizenz und ein OpenAPI-Token verfügt. Diese Anmeldedaten sind erforderlich, um Ihre Anfragen an die API zu authentifizieren und zu autorisieren.

Entdecken Sie die entscheidenden Vorteile des OpenAPI-Tokens von SecuReporter

Optimieren Sie Ihre Arbeitsabläufe, verbessern Sie die Skalierbarkeit und ermöglichen Sie nahtlose Automatisierung. Erleben Sie eine sichere, effiziente und benutzerfreundliche Methode für den Zugriff auf Firewall-Protokolldateien, die sowohl manuelle als auch automatisierte Prozesse unterstützt.

Komfort und Effizienz

Greifen Sie direkt über HTTP-Anfragen mit beliebigen Programmiersprachen oder cURL-Befehlen auf Ihre Firewall-Protokolle zu – eine Anmeldung im Portal ist nicht erforderlich. Dies optimiert Ihren Arbeitsablauf, spart Zeit und eignet sich perfekt für automatisierte Systeme oder Skripte, die einen regelmäßigen Abruf von Protokollen erfordern.

Skalierbarkeit

OpenAPI-Token ermöglichen einen skalierbaren Zugriff auf Firewall-Protokolle. Generieren Sie mehrere Token für verschiedene Benutzer oder Systeme und sichern Sie sich so Flexibilität und Kontrolle.

Automatisierungsmöglichkeiten

Nahtlose Integration in andere Systeme und Software mithilfe von API-Token. Automatisieren Sie den Abruf von Firewall-Protokollen und binden Sie diese Daten ohne manuellen Eingriff in Ihre SIEM-Systeme (Security Information and Event Management) ein.

Warum das OpenAPI-Token von SecuReporter integrieren?

SecuReporter bietet eine sichere, effiziente und benutzerfreundliche Methode für den Zugriff auf Firewall-Protokolldateien. Es unterstützt sowohl manuelle als auch automatisierte Prozesse und gewährleistet dabei hohe Sicherheitsstandards. Weitere Informationen zur OpenAPI-Integration von SecuReporter und mehr finden Sie auf unserem GitHub.

Zyxel GitHub

FAQ zur nahtlosen Integration

Keine Sorge, wir haben alles für Sie im Griff! Während Sie sich mit der Integration von OpenAPI in SecuReporter vertraut machen, finden Sie hier einige hilfreiche Tipps und häufig gestellte Fragen, die Sie durch den Prozess führen.

Der „Archived Logs Service“ ist der erste offene Dienst, der von SecuReporter OpenAPI angeboten wird. Er ermöglicht es Benutzern, mithilfe eines API-Tokens Firewall-Protokolle der letzten bis zu 31 Tage abzurufen. Jedes API-Token gewährt maximal 50 API-Anfragen pro Stunde. Seien Sie gespannt auf weitere Dienste, die in Zukunft veröffentlicht werden.

Bitte leiten Sie die E-Mail mit dem Ticket/Fall an Ihren lokalen Zyxel-Vertriebsmitarbeiter oder Vertriebsingenieur weiter, um Ihre Funktionsanfrage hinsichtlich ihrer Auswirkungen zu prüfen

Voraussetzungen:

Stellen Sie sicher, dass Ihr Firewall-Gerät über eine aktive SecuReporter-Lizenz verfügt und der SecuReporter-Dienst aktiviert ist. Sollte Ihre Lizenz abgelaufen sein, wenden Sie sich bitte an den Gerätebesitzer oder erwerben Sie eine neue Lizenz im Zyxel-Marktplatz, um auf den OpenAPI-Dienst zugreifen zu können.

Schritte zum Generieren eines OpenAPI-Tokens in SecuReporter:

Schritt 1: Wählen Sie das Gerät mit einer gültigen SecuReporter-Lizenz aus und klicken Sie auf die Schaltfläche „API-Zugriff“.

Schritt 2: Klicken Sie auf die Schaltfläche „Neues API-Token erstellen“.

Schritt 3: Kopieren Sie das OpenAPI-Token.

Zum Testen der OpenAPI stehen zwei Methoden zur Verfügung: cURL und Python.

[1] Testen mit cURL

  • Vorbereitung: Um zu überprüfen, ob cURL installiert ist, öffnen Sie die Eingabeaufforderung oder das Terminal und geben Sie „curl“ ein. Wenn eine Fehlermeldung angezeigt wird, dass cURL nicht gefunden wurde, befolgen Sie die Installationsanweisungen im cURL-GitHub-Repository.
  • Erstellen Ihrer ersten OpenAPI-Anfrage: Öffnen Sie Ihre Eingabeaufforderung/Ihr Terminal und verwenden Sie den folgenden Befehl. Ersetzen Sie „yyyy-MM-dd“ durch ein Datum innerhalb der letzten 31 Tage (ohne das aktuelle Datum) im Format „yyyy-mm-dd“. Ersetzen Sie „mydir“ durch den tatsächlichen Pfad Ihres Download-Ordners auf Ihrem Computer.

macOS

curl -X POST \

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \

-H "Content-Type: application/json" \

-H "X-Authorization: Bearer $OPEN_API_TOKEN" \

-d "{\"device_date\":\"yyyy-MM-dd\"}" \

-o mydir/archive.tar

Windows

curl -X POST ^

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^

-H "Content-Type: application/json" ^

-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^

-d "{\"device_date\":\"yyyy-MM-dd\"}" ^

-o mydir\archive.tar

Ersetzen Sie „https://api.example.com/endpoint“ durch den tatsächlichen API-Endpunkt und „your_api_token“ durch Ihren API-Token.

[2] Testen mit Python

  • Python-Installation überprüfen: Um zu überprüfen, ob Python installiert ist, öffnen Sie die Eingabeaufforderung oder das Terminal und geben Sie „python“ ein. Wenn eine Fehlermeldung angezeigt wird, dass Python nicht gefunden wurde, können Sie es installieren, indem Sie den Anweisungen auf der offiziellen Python-Website folgen. Stellen Sie sicher, dass Python 3.8 oder neuer installiert ist, um die Requests-Bibliothek nutzen zu können.
  • Erstellen und Aktivieren einer virtuellen Umgebung:
    Erstellen eines Projektverzeichnisses und einer virtuellen Umgebung: Befolgen Sie die offizielle Python-venv-Dokumentation, um Ihre virtuelle Umgebung in einem Projektverzeichnis zu erstellen.

macOS

source your-virtual-environment-path/bin/activate

Windows

Pfad-zu-Ihrer-virtuellen-Umgebung\Scripts\activate

Ersetzen Sie „Pfad-zu-Ihrer-virtuellen-Umgebung“ durch den tatsächlichen Pfad zu Ihrem Verzeichnis für die virtuelle Umgebung.

Jede Website kann ein API-Token generieren, das von mehreren Systemen oder Softwareanwendungen genutzt werden kann. Es gilt jedoch eine Nutzungsbeschränkung von 50 Anfragen pro Stunde für jedes API-Token.