Erste Schritte mit der neuen RESTful-API von WhatsUp Gold

Letzten Monat haben wir WhatsUp Gold 2019.1 veröffentlicht und damit eine leistungsstarke REST-API, mit der Sie problemlos andere Systeme oder Ihre eigenen Skripte in WUG integrieren können.

Mit der neuen REST-API können Sie jetzt eine umfangreiche Palette von REST-API-Aufrufen verwenden, um Daten von WhatsUp Gold von anderen Systemen abzuholen, Daten in WhatsUp Gold einzugeben oder andere Systeme Änderungen vornehmen zu lassen. Das Ergebnis ist eine Vielzahl von Automatisierungs-Anwendungsfällen, die HELFEN SIE IT-TEAMS, schneller und effizienter zu sein. Beispiele für Anwendungsfälle sind die Möglichkeit, Geräte automatisch in den Wartungsmodus zu versetzen, bevor Änderungen vorgenommen werden, die Möglichkeit, Geräte und Monitore automatisch hinzuzufügen oder zu entfernen und vieles mehr.

Das Beste daran ist, dass REST-APIs sprach- und plattformunabhängig sind, wodurch sie den unnötigen Bedarf an Client-Server-Abhängigkeitswartung umgehen und jede Kombination von Umgebungen (einschließlich IoT, Mobile und vieles mehr) umfassen können.

Wie fangen Sie also an? Wenn Sie bereits eine REST-API verwendet haben, sollte das Erlernen der REST-API von WhatsUp Gold einfach sein.  Die API wird über Swagger verfügbar gemacht, mit dem Sie die API und ihre Optionen einfach erkunden können.  Mit Swagger können Sie experimentieren mit verschiedenen API-Aufrufen und erfahren Sie genau, was jede API für die Eingabe erwartet und was sie für die Ausgabe produziert.  Die "Try it out"-Funktion von Swagger führt eine API gegen den Live-WUG-Server aus, sodass Sie jede API testen und die Ergebnisse beobachten können.

Im Folgenden geben wir Ihnen einen kurzen Überblick darüber, wie Sie mit der neuen RESTful-API von WUG beginnen können und wie Sie Swagger verwenden können, um die API zu erkunden und Aufrufe zu testen. Eine ausführlichere Anleitung zur API, einschließlich Pfaden und Definitionen, finden Sie in unserem vollständigen RESTful API Guide.

Was Sie für die ersten Schritte benötigen

Zuerst müssen Sie wissen, wie Sie mit unserer REST-API kommunizieren. Im Allgemeinen erwartet diese RESTful-API die folgenden Verben: GET (Abfragedatensatz), PUT (Datensatz erstellen), PATCH (Datensatz ändern/aktualisieren) oder DELETE (Datensatz entfernen).

Sie müssen auch die folgenden REST-Endpunkte und die von ihnen bereitgestellten Ressourcen kennen:

1. /api/v1/token können Sie ein Sitzungstoken abrufen, erneuern oder aktualisieren.
2. /api/v1/device-groups gibt Ihnen Informationen über ein Gerät für eine bestimmte Gruppe.
3. /api/v1/devices ermöglicht das Verwalten, Überwachen und Abfragen von Geräten in WUG.
4. /api/v1/product gibt Ihnen Produkt- und Versionsinformationen.
5. /api/v1/devices/{deviceId}/reports/ gibt einen Bericht für ein bestimmtes Gerät ab.
   /api/v1/device-groups/{groupId}/devices/reports/ gibt einen Bericht für eine bestimmte Gruppe von Geräten ab.
6. /api/v1/errors ist ein Dienstprogrammendpunkt zum Abrufen von Fehlervorlageninformationen.
7. /api/v1/monitors können Sie Monitorvorlagen abrufen, konfigurieren und anwenden.
8. /swagger gibt Ihnen live swagger UI interaktive Dokumentation.

Bevor Sie mit der REST-API von WUG beginnen können, gibt es einige Grundlagen, die Sie benötigen:

• Der Hostname für ein bereitgestelltes WhatsUp Gold 2019-System.
• Der Benutzername und das Kennwort für einen Benutzer auf dem WhatsUp Gold-Zielsystem.
• Ihr bevorzugter HTTP-Client (die folgenden Beispiele verwenden das Dienstprogramm cURL).

Sie benötigen auch diese URLs:

Swagger UI: http://<your-whatsup-gold-server>:9644/swagger/ui/index#/

Primärer REST-API-Endpunkt: https://<your-WhatsUp-Gold-server>:9644/swagger/api/v1

Swagger API Spezifikationen und Dokumente: https://<your-WhatsUp-Gold-server>:9644/swagger/docs/v1

Von hier aus können Sie schnell überprüfen, ob die REST-API bereits auf Anfragen am WhatsUp Gold-Host wartet, indem Sie in Ihren Webbrowser eingeben https://<your-WhatsUp-Gold-server-host>:9644/swagger/docs/v1 (Wo <your-WhatsUp-Gold-server-host> ist der Hostname des WhatsUp Gold-Systems). Wenn dieser Aufruf ein JSON-Objekt zurückgibt, wird Ihre API ausgeführt, und Sie können die folgenden Schritte mit diesem Hostnamen beginnen.

Verwenden der Swagger-Benutzeroberfläche, des interaktiven REST-API-Clients

Wie oben erwähnt, bietet Swagger UI eine einfache Möglichkeit, die WhatsUp Gold REST-Dokumentation mit Live-Beispielen zu durchsuchen, und bietet einen einfachen Entwicklungsclient zum Testen von WhatsUp Gold REST-Aufrufen. Es ist jedoch zu beachten, dass es sich bei den Beispielen um Live-Anrufe handelt. (nicht simuliert), die gegen Ihre WhatsUp Gold-Umgebung laufen. Wenn Sie nur die Funktionen der REST-API für Entwicklungszwecke testen und untersuchen, wird es als bewährte Methode verwendet, mit einer Nicht-Produktionsinstanz von WhatsUp Gold ausgeführt zu werden.

Führen Sie die folgenden Schritte aus, um mit Swagger zu beginnen:

1. Öffnen Sie einen Browser für https://my-whatsup-gold-host:9644/swagger/ --Wo my-whatsup-gold-host ist der Host, auf dem Sie WhatsUp Gold installiert haben
2. Klicken Sie auf die Schaltfläche Anmelden.
3. Durchsuchen und erstellen Sie Abfragen und zeigen Sie JSON-Ergebnisobjekte an.

Einen tieferen Überblick finden Sie im folgenden Video:

curl -k --request POST --url https://my-whatsup-gold-host:9644/api/v1/token --data "grant_type=password&username=emmacurtis&password=1a2B3cA1b2C3"

{
  "access_token": "X03w.....dziTwmA",
  "token_type": "bearer",
  "expires_in": 86399,
  "refresh_token": "X03w.....dziTwmA"
}

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer X03w.....dziTwmA' 'http://my-whatsup-gold-host:9644/api/v1/device-groups/0/devices'

{
  "paging": {
    "size": 96
  },
  "data": {
    "devices": [
      {
        "hostName": "192.168.37.1",
        "networkAddress": "192.168.37.1",
        "bestState": "Up",
        "worstState": "Up",
        "name": "192.168.37.1",
        "id": "14"
      },
      {
        "hostName": "192.168.37.100",
        "networkAddress": "192.168.37.100",
        "bestState": "Maintenance",
        "worstState": "Maintenance",
        "name": "192.168.37.100",
        "id": "16"
      },

Von hier aus können Sie Ihre eigenen Skripte einrichten, um unsere neue REST-API auf jede Art und Weise zu verwenden, die Sie für richtig halten. Eine vollständige technische Beschreibung der API und ihrer Funktionen finden Sie im WhatsUp Gold REST API Guide. Dann kommen Sie mit uns auf den Progress| Ipswitch Community zum Teilen Skripte und diskutieren Sie Ihre Ideen. Wir sind gespannt, wie Sie WhatsUp Gold nutzen können! Viel Spaß beim Programmieren!