Uptrends API-Prüfobjekte können eine einzelne Antwort überprüfen oder komplexe mehrstufige API-Aufrufe handhaben. Bei dieser Lektion behandeln wir die Grundlagen der Einrichtung des API-Prüfobjekts.

Welche Typen von API-Prüfobjekten gibt es?

Ein mehrstufiges API Monitoring-Prüfobjekt erstellen

Halte während des Einrichtungsvorgangs Deine API-Dokumentation bereit.

  1. Klicke auf + Prüfobjekt hinzufügen unter Prüfobjekte im Hauptmenü, um den Konfigurationsbildschirm Neues Prüfobjekt aufzurufen.
  2. Wähle Multi-step API aus der Liste unter Typ.
  3. Gib Deinem Prüfobjekt einen Namen.
  4. Lege die Überwachungs-Frequenz fest.
  5. Wechsele zur Registerkarte Schritte.

Okay. Sprechen wir einmal kurz darüber, was wir mit Schritt meinen.

Was ist ein Schritt?

Ein Schritt bei einem Multi-step API Monitoring besteht aus einem vollständigen API-Aufruf (d. h. eine Anfrage und eine Antwort). Bei jedem Schritt kannst Du die Anfrage definieren und Uptrends mitteilen, wie es mit der Antwort umgehen soll. Jede Multi-step API beginnt mit einem leeren Schritt. Füllen wir ihn aus.

Eine Anfrage einrichten

Auf der Registerkarte Schritte beim Multi-step API-Prüfobjekt siehst Du einen Schritt in der Spalte Schritte, aber die Registerkarten für Request und Response (auf der rechten Seite) sind beide leer. Das ändern wir nun.

Die Seite zeigt standardmäßig die Registerkarte Request (auf der rechten Bildschirmseite an).

  1. Wähle Deine HTTP Method und gib die URL ein. Die Methode lautet standardmäßig GET, aber es erscheint ein Textfeld, wenn Du POST, PUT oder Delete wählst. In dieses Feld kannst Du deinen Anfrage-Text eingeben.
  2. Klicke auf die Schaltfläche Request Header hinzufügen, um einen Request-Header-Key und -Wert hinzufügen (Mehr erfahren).
    Üblicherweise verfügen Header über Name/Wert-Paare:

    - Accept zusammen mit application/json oder text/xml oder application/x-ww-form-urlencoded

    - Content-Type mit application/json oder text/xml oder application/x-ww-form-urlencoded

    - Authorization mit den entsprechenden Daten im Feld Wert.
  3. Hinweis: Solltest Du den Beispielwert mehrmals nutzen müssen, kannst Du den Wert im Abschnitt Vordefinierte Variablen am Ende der Schritte-Seite einfügen. Weitere Informationen findest Du unter Vordefinierte Variablen in der Knowledge Base.
  4. Richte die Authentication und das Client Zertifikat ein, aktiviere TLS/SSL Zertifikat Fehler ignorieren, wenn Du keine Warnmeldungen zu diese Art Fehler erhalten möchtest, und gib eine Kurzbeschreibung unter Name des Schritts ein.

Mit der Antwort arbeiten

Wenn Uptrends die Anfrage gesendet hat, müssen wir wissen, was wir mit der Antwort machen sollen. Sehen wir uns also die Optionen für die Handhabung der Antwort an.

  1. Klicke auf die Registerkarte Response oben auf der rechten Bildschirmhälfte.
  2. Klicke auf Assertion hinzufügen (Mehr erfahren).
  3. Wähle im ersten Feld (Response Body) den Antworttyp aus. Uptrends verwendet Deine Wahl zur Einrichtung der übrigen Assertion-Felder. Probiere die unterschiedlichen von dir wählbaren Antworttypen aus. Als erste Assertion könntest Du zum Beispiel den Status Code prüfen. Dafür musst Du zwei weitere Felder eingeben.
  4. Setze den Vergleichsoperator. Wir sollten sicherstellen, dass die Anfrage erfolgreich ist, also wählen wir „Ist identisch mit“.
  5. Gib im letzten den Wert ein, der geprüft werden soll. In diesem Fall möchten wir sicherstellen, dass die Anfrage erfolgreich ist, also wählen wir „200“.
  6. Füge weitere Assertions nach Bedarf hinzu. 
  7. Füge Variablen für Werte hinzu, die Du wiederverwenden musst, indem Du auf die Schaltfläche Variable hinzufügen klickst. Setze den Antworttyp, füge eine Abfrage oder einen Ausdruck hinzu und gib der Variablen einen Namen (erfahre, wie Du Variablen definierst und nutzt).
  8. Klicke auf Speichern, wenn das Prüfobjekt nur eine Anfrage senden soll. Andernfalls füge Schritte anhand der Schaltfläche + Schritt hinzufügen auf der linken Seite hinzu.

     

    Hinweis: Detaillierte Anweisungen und Beispiele findest Du im Abschnitt API Monitoring der Knowledge Base.