Zum Inhalt springen
Produkte
Plattform
Developer Tools
Portal

API Postman Collection Observability

Zuletzt aktualisiert am

Verwendung einer Postman-Collection zur Kommunikation mit der Observability API

Abschnitt betitelt „Verwendung einer Postman-Collection zur Kommunikation mit der Observability API“

In diesem Tutorial lernen Sie, wie Sie Postman-Collections verwenden, um die STACKIT Observability API zu nutzen und zu testen. Wir haben eine Collection erstellt, welche die Observability API enthält. Diese Collection kann in Postman importiert werden, worum es in diesem Artikel geht.

Voraussetzungen

Abschnitt betitelt „Voraussetzungen“
  • Postman installiert
  • Kenntnisse über RESTful-API
  • Kenntnisse über HTTP-Anfragen

Arbeiten mit der Collection

Abschnitt betitelt „Arbeiten mit der Collection“

Importieren der Collection in Postman

Abschnitt betitelt „Importieren der Collection in Postman“
  1. Laden Sie die Observability Postman Collection auf GitHub herunter.
  2. Öffnen Sie Postman und wählen Sie File->Import.
  3. Gehen Sie in das Verzeichnis, das Ihre Collection-Datei enthält, wählen Sie diese aus und klicken Sie auf Open.
  4. Sie sollten einen Bildschirm wie unten dargestellt erhalten und auf der linken Seite sollte STACKIT Observability API zu sehen sein.

Screenshot der Postman-Anwendung mit einer importierten Collection namens „STACKIT Argus API“ in der linken Seitenleiste. Der Hauptbereich zeigt den Reiter „Authorization“ der Collection, welcher auf „Basic Auth“ eingestellt ist und Eingabefelder für Benutzernamen (Username) und Passwort (Password) bereitstellt. Auf der rechten Seite ist das Panel „Documentation“ geöffnet, das API-Übersichtsdetails, Support-Kontakte sowie die nächsten Collection-Elemente – darunter ein Ordner namens „v1“ und eine GET-Anfrage mit der Bezeichnung „list“ – anzeigt.

Konfigurieren der Collection in Postman

Abschnitt betitelt „Konfigurieren der Collection in Postman“

Vor der Verwendung der API sollten einige Schritte durchgeführt werden:

  1. Wählen Sie die Collection auf der linken Seite aus.
  2. Geben Sie Ihren Benutzernamen und Ihr Passwort (welche Sie von Ihrer Observability-Instanz erhalten → service credential key) im Reiter Authorization ein.
  3. Wechseln Sie zum Reiter Variables.
  4. Ändern Sie die baseUrl in Ihre URL.
  5. Öffnen Sie die Collection, indem Sie auf das > Zeichen klicken.
  6. Führen Sie die „GET“-Anfrage list durch Klicken und Send aus, um zu testen, ob die Anfragen funktionieren.
  7. Auf der rechten Seite sollten Sie eine kleine Zeile wie unten sehen können. Wenn diese erscheint, war die Anfrage erfolgreich. Screenshot einer erfolgreichen API-Antwort-Statuszeile in Postman. Zu sehen ist der grüne Text „Status: 200 OK“, gefolgt von „Time: 144 ms“, „Size: 1.54 KB“ und einem blauen Dropdown-Link „Save Response“ auf der rechten Seite.
  8. Testen Sie die Zugangsdaten, indem Sie eine weitere Anfrage senden.
    1. Klicken Sie auf den Ordner v1 der Collection.
    2. Wählen Sie die „GET“-Anfrage mit der Beschreibung v1 instances read aus.
    3. Klicken Sie auf die Schaltfläche „Send“.
  9. Wenn Sie Status: 200 OK sehen, war die Anfrage erfolgreich. Falls nicht, prüfen Sie die Dokumentation durch Klicken auf:

Detaillierter Screenshot der rechten Seitenleiste in der Postman-Benutzeroberfläche. Am äußersten rechten Rand ist eine vertikale Reihe von Aktions-Symbolen zu sehen, wobei das oberste Dokumentations-Symbol (ein Blatt Papier mit Zeilen) durch einen dicken, handgezeichneten schwarzen Kreis deutlich hervorgehoben ist.

Dies öffnet eine kleine Seite mit Kriterien für das Senden einer erfolgreichen Anfrage.

Weitere Informationen

Abschnitt betitelt „Weitere Informationen“

Sie können den Teil der Autorisierung anpassen, indem Sie eine andere Autorisierungsmethode wählen. Diese Aktion kann innerhalb jeder Anfrage durchgeführt werden, indem Sie auf den Reiter Authorization klicken und die Autorisierungsmethode ändern.