1. Support
  2. Knowledge Base
  3. Synthetic monitoring
  4. API Monitoring

API Monitoring

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:

Schritte beim Multi-step API Monitoring definieren

Bei der Einrichtung eines Multi-step API-Prüfobjekts musst du die Schritte mit den HTTP-Anfragen definieren, die Teil des zu überwachenden Szenarios sind. Für jeden Schritt musst du die Einzelheiten für die Anfrage und den Antwortteil festlegen. Zudem gibt es einige Definitionen für benutzerdefinierte Funktionen, Variablen und 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. Weitere Informationen findest du in den folgenden Artikeln:

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. Weitere Informationen über Assertions findest du in diesen Artikeln:

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:

Die Skript-Ansicht

Du kannst Schrittdefinitionen des Multi-step API-Prüfobjekts auch direkt in der Skript-Ansicht bearbeiten. Weitere Informationen findest du im Artikel zum MSA Skript-Editor.

Artikel in dieser Kategorie

  • Benutzerdefinierte Funktionen
    Ein Überblick der verfügbaren benutzerdefinierten Funktionen und wie sie eingesetzt werden
  • Das Multi-step API Monitoring einrichten
    Detaillierte Anweisungen zur Einrichtung des Multi-step API Monitorings.
  • Der Multi-step API-Prüfobjekte-Hub
    Dein Einstieg, wenn du das Multi-step API Monitoring kennenlernen möchtest
  • Der Multi-step API-Skript-Editor
    Ein Überblick über den Skript-Editor des Multi-step API-Prüfobjekts
  • Einrichtung von Custom API Metrics
    Hier erfährst du, wie du benutzerdefinierte Metriken verwenden kannst, um Daten von APIs zu erfassen. Dabei kann es sich um eine API eines Technologie-Anbieters, die du geschäftlich einsetzt, oder deine eigenen API, die du zur Unterstützung deiner Kunden oder Prozesse entwickelt hast, handeln. Es kann sogar eine benutzerdefinierte API sein, die du programmiert hast, um interne geschäftliche Daten oder Plattformmetriken zu erfassen und zu berechnen. Test-Tools und Monitoring-Lösungen sorgen dafür, dass deine APIs korrekt funktionieren.
  • Hash- und/oder Codierungswerte
    In bestimmten Situationen des API-Monitorings kann es notwendig sein, Variablen oder Werte als Hash oder codiert zu übergeben. Zum Beispiel kann es für Autorisierungen erforderlich sein, eine Base64-Codierung oder einen HMAC-SHA256-Hash einzusetzen, um richtig zu funktionieren. Oder du musst vielleicht in deiner Anfrage codiertes JSON verwenden. Zu diesem Zweck bietet Uptrends verschieden Codierungs- und Hash-Optionen, die wir in diesem Artikel beschreiben. Codieren und Decodieren Das Codieren ist ein Vorgang, bei dem sichergestellt wird, dass Daten in einer bestimmten Form zuverlässig übermittelt werden können.
  • Monitoring von Webservices
    Ihnen sind vielleicht das Website Monitoring und Server-Prüfobjekttypen von Uptrends ein Begriff, aber Uptrends unterstützt auch das Monitoring der Verfügbarkeit von Webservices. Lesen Sie weiter, um mehr zu erfahren… Welche Webservices werden überwacht? Uptrends unterstützt REST und SOAP, genauso wie alle Webservices, die über HTTP und HTTPS aufgerufen werden. Wie funktionieren diese Webservices mit Uptrends? Wir überwachen, dass die Webservice-Antwort HTTP 200 OK lautet und messen die Auflösungs-/Verbindungszeit, Ladezeit und Gesamtzeit, genauso wie HTTP(S)-Prüfobjekte Das Webservice Monitoring unterstützt auch grundlegende Authentifizierung, Inhaltsüberwachung usw.
  • Multi-step Monitoring – Assertions
    Grundlagen zu Assertions beim Multi-step API Monitoring.
  • Multi-step Monitoring – Authentifizierung
    Erfahre mehr über die verfügbaren Authentifizierungsoptionen beim Multi-step API Monitoring.
  • Multi-step Monitoring – Client-Zertifikatauthentifizierung
    Viele APIs erfordern, dass der Aufrufende Authentifizierungsinformationen angibt, um die Identität – und möglicherweise die Zugriffsberechtigungen – des Aufrufenden zu verifizieren. Authentifizierungsinformationen können über den HTTP-Header (Basic/NTLM/Digest-Authentifizierung), durch Austausch von Zugriffs-Tokens (OAuth) übermittelt werden, indem vom Client die Mitgabe eines Client-Zertifikats in der Anfrage erwartet oder eine Kombination davon weitergegeben wird. In diesem Artikel werden Optionen für Client-Zertifikate behandelt. Um die üblichen Authentifizierungsmethoden einzurichten, lies bitte den Artikel zu Authentifizierungsarten.
  • Multi-step Monitoring – Handhabung von Redirects
    Erfahre, wie du Weiterleitungen bei deinen Multi-step API-Prüfobjekten handhabst.
  • Multi-step Monitoring – Quellen
    Das Extrahieren von Werten für Assertions oder Variablenzuordnungen bei der Einrichtung eines Multi-step API Monitorings.
  • Multi-step monitoring – Variablen
    Aus API-Antworten erhaltene Variablen zum Speichern und Einsatz von Werten in späteren Schritten verwenden.
  • Multi-step Monitoring – Vergleichsoperatoren
    Erfahre mehr über die Vergleichsoperatoren, die bei der Einrichtung eines Multi-Step API Monitorings verfügbar sind.
  • Public-Key-Informationen zu Uptrends’ Client-Zertifikat
    Der Einsatz von Uptrends’ öffentlichem Schlüssel bei deinen Multi-Step API-Prüfobjekt-Requests, um sicherzustellen, dass API-Prüfobjekt-Abfragen von Uptrends stammen.
  • SOAP-Einrichtung
    Wenn du ein SOAP-Prüfobjekt in deinem Uptrends Account einrichten möchtest, findest du die Anleitung in diesem Artikel. Ein SOAP-Webservice-Prüfobjekt einrichten Das Testen eines SOAP-Service beginnt in der Regel mit dem Aufruf einer Methode des Webservice, indem Daten in das Formular eines SOAP Envelopes eingegeben werden, und der anschließenden Verifizierung, dass die Antwort korrekt ist. Rufe den Konfigurationsbildschirm Prüfobjekt hinzufügen auf. (Wenn du eine Erinnerung brauchst, wie dies geht, lies den Artikel Ein Prüfobjekt hinzufügen Setze den Prüfobjekttyp auf Webservice HTTP oder Webservice HTTPS.
  • XPath-Beispiele beim Multi-step Monitoring
    In diesem Artikel findest Du einige Beispiele für das Extrahieren von Inhalten aus XML-Antworten mithilfe von XPath. Diese XPath-Abfragen ermöglichen Dir, eine XML-Antwort zu untersuchen, die von Deiner API oder Deinem Webservice im Rahmen eines Multi-step API Monitorings ausgegeben wird. Eine XPath-Abfrage definiert, welcher Teil der XML-Antwort Dich interessiert. Es ist üblicherweise ein Wert, der in einem der XML-Knoten enthalten ist. Du kannst den extrahierten Wert dahingehend prüfen, ob er bestimmte Bedingungen erfüllt (anhand von Assertions), oder zur späteren Nutzung in einer Variablen speichern.
Durch die Nutzung dieser Website stimmen Sie der Verwendung von Cookies gemäß unserer Cookie-Richtlinien zu.