Eine API (Application Programming Interface) ist eine Software, die eine Kommunikation zwischen Anwendungen ermöglicht. Möglicherweise nutzt du deine eigene API und/oder verlässt dich auf APIs Dritter. So oder so ist die richtige Funktionsweise der APIs grundlegend für den Betrieb deiner Website und Services und du solltest sie überwachen.
Das API Monitoring prüft, ob die APIs, auf die du dich verlässt, verfügbar, funktionstüchtig und leistungsstark sind. Weitere Informationen findest du im Artikel Was ist API Monitoring? .
Das API Monitoring von Uptrends bietet unterschiedliche Prüfobjekttypen, um ein API Monitoring einzurichten. Die Typauswahl hängt davon ab, ob es sich um einen einzelnen Schritt oder eine Reihe von Anfragen mit mehreren Schritten handelt. Das Prüfobjekt für einen Schritt wird mit dem Prüfobjekttyp Webservice HTTP oder Webservice HTTPS eingerichtet. Das Prüfobjekt für eine Reihe aufeinanderfolgender Schritte wird anhand des Multi-Step API-Prüfobjekttyps (MSA-Prüfobjekt) definiert.
Die Uptrends Anwendung verfügt über einen Multi-Step API-Prüfobjekt-Hub , bei dem du Informationen zu diesen Prüfobjekten und dem aktuellen Status an einem Ort findest.
API-Prüfobjekte einrichten
Die Einrichtung unterschiedlicher Prüfobjekttypen wird in diesen Artikeln beschrieben:
- Das Webservices-Monitoring einrichten
- Das Webservice-Monitoring einrichten (SOAP)
- Das Multi-Step API Monitoring einrichten
Schritte beim Multi-Step API Monitoring definieren
Bei der Einrichtung eines Multi-Step API-Prüfobjekts definierst du einen Schritt für jede HTTP-Anfrage, die Teil des zu überwachenden Szenarios ist. Für jeden Schritt gibt es zwei Aspekte zu bedenken: Zunächst gibst du die Daten für die Anfrage ein und definierst, was ausgeführt und an die API gesendet wird. Dann gibst du die Daten für die Antwort ein und definierst, was in der Antwort der API geprüft werden muss.
Sowohl der Anfrage- wie auch der Antwort-Teil können für jeden Schritt erweitert werden – anhand von eigenen Skripten in JavaScript. Du kannst deine eigenen Skripte für Authentifizierungen hinzufügen und Berechnungen und eigene Programmierungen ausführen, um die korrekte Funktion und den Inhalt der API-Schritte zu verifizieren.
Zudem gibt es einige Definitionen für benutzerdefinierte Funktionen , Variablen und benutzerdefinierte Metriken . Diese werden global festgelegt (verfügbar bei allen Schritten). In den Artikeln der folgenden Abschnitte erfährst du mehr über das Einrichten der HTTP-Schritte.
Request
Der HTTP-Schritt Request (Anfrage) wird durch Angabe einer Methode und einer URL sowie des Request Bodys eingerichtet. Dann werden weitere Details wie zum Beispiel die Authentifizierung angegeben. Die Request-Definition kann auch mit eigenen Skripten weiter angepasst werden. Weitere Informationen findest du in den folgenden Artikeln:
- Authentifizierung
- Client-Zertifikate
- Uptrends‘ Client-Zertifikat
- Datei-Uploads beim Multi-Step API Monitoring
- Eigene Skripte
Response
Im Teil Response (Antwort) des Schritts solltest du Assertions (Prüfpunkte) definieren. Assertions sind Prüfungen, die weiter als die Frage gehen, ob es zu der Anfrage eine Antwort gibt. Eine Assertion prüft auch, ob die Antwort gültig ist oder zeitgerecht empfangen wird. Für jeden Schritt kannst du mehrere Assertions bestimmen. Neben der Definition von Assertions auf der Registerkarte Response kannst du vollständig angepasste Prüfungen und eigene Programmierungen mithilfe der Funktion für eigene Skripte einrichten. Weitere Informationen über Assertions findest du in diesen Artikeln:
- Assertions – Einführung
- Assertions – Quellen
- Assertions – Vergleichsoperatoren
- Assertions – Beispiele mit XPath
- Variablen
- Weiterleitungen handhaben
- Eigene Skripte
Globale Definitionen
Es gibt eine Reihe von Aspekten, die du für alle Schritte und sowohl für ihren Anfrage- wie auch den Antwortteil definieren kannst. Das kann praktisch sein, wenn du einen bestimmten Wert oder eine Funktion in unterschiedlichen Schritten verwenden möchtest. In den folgenden Artikeln findest du mehr dazu:
- Vordefinierte Variablen
- Benutzerdefinierte Funktionen
- Benutzerdefinierte Metriken
- Hashing und Codierung
Die Skript-Ansicht
Du kannst Schrittdefinitionen des Multi-Step API-Prüfobjekts auch direkt in der Skript-Ansicht bearbeiten. Dieses Skript enthält die komplette Definition deiner Multi-Step API-Einrichtung, die du kopieren und an anderen Stellen einfügen kannst. Weitere Informationen findest du im Artikel zum MSA Skript-Editor .
Beachte, dass die Skript-Ansicht nicht dasselbe ist, wie die Funktion Eigene Skripte , bei der du eigene Programmierungen in deine Skripte einfügen kannst.