So senden Sie eine Anforderung an die Rest-Web-API

Anforderungstyp

Die REST-Web-API-Task unterstützt verschiedene HTTP-Methoden, die entsprechend Ihren Überwachungszielen verwendet werden können. Wenn Sie eine GET-Anforderung auswählen, werden einfach Daten aus Ihrer Web-API abgerufen. Obwohl Anforderungsparameter in der URL enthalten sein können, wird empfohlen, dedizierte Methoden zu verwenden, um die Nutzlast an eine API zu übertragen.

Um benutzerdefinierte Informationen zu senden, Daten zu ändern oder Flow oder Ereignis auszulösen, verwenden Sie Anforderungentypen wie POST, PUT oder PATCH. Navigieren Sie in diesem Fall zum Abschnitt Daten buchen, um den Anforderungstext anzugeben.

Wenn Sie den Anforderungstyp auf POST, PUT oder PATCH festlegen, aber die Anforderungsparameter im Abschnitt “Daten buchen” nicht angeben, wird der Anforderungstyp beim Speichern der Aufgabe wieder in GET geändert.

Authentifizierung

Wenn Ihre API eine Authentifizierung erfordert, geben Sie die Anmeldeinformationen im Abschnitt “Standardauthentifizierung” an. Wenn die tokenbasierte Authentifizierung die verwendete Methode ist, befolgen Sie die Empfehlungen für OAuth 2.0-basierte APIs, und konfigurieren Sie Authentifizierungsparameter auf ähnliche Weise.

Post-Daten

In diesem Abschnitt können Sie ganz einfach alle Anforderungsentitäten bereitstellen, z. B. JSON.

Um den Anforderungstext anzugeben, fügen Sie einfach JSON-Inhalt ein oder geben Sie ihn in das Feld ein. Das System analysiert den Code automatisch, und Sie werden aufgefordert, einen Inhaltstypheader basierend auf dem Anforderungstexttyp auszuwählen. Außerdem können Sie bei Bedarf einen benutzerdefinierten Inhaltstypheader bereitstellen.

Nach der Angabe wird der Inhaltstyp automatisch zum Abschnitt Headers hinzugefügt.

Ergebnisvalidierung

Im Allgemeinen reicht es nicht aus, einfach einen Aufruf einer API zu tätigen, mit dem Ziel, sicherzustellen, dass die API-Antwort Daten enthält, die erwartet wurden. Um die API-Antwort zu überprüfen, reicht es aus, einige Schlüsselwörter zu finden, die genau in der Antwort übereinstimmen. Wenn Sie Ihren API-Antwortinhalt kennen, können Sie die Schlüsselwörter im Abschnitt Inhaltsvalidierung bereitstellen. Weitere Informationen finden Sie im Artikel “Schlüsselwort”.

Anwendungsfälle

Betrachten wir eine E-Mail-REST-API als Beispiel. Um den Dienst zu überwachen, müssen wir die POST-Anforderung zusammen mit den E-Mail-Details im Anforderungstext an den entsprechenden API-Endpunkt senden. Dazu müssen wir die Endpunkt-URL angeben und den POST-Anforderungstyp auswählen.

Da die E-Mail-REST-API eine Standardauthentifizierung erfordert, müssen wir auch die Anmeldeinformationen im entsprechenden Abschnitt angeben.

Im Abschnitt “Daten nach” geben wir das JSON-Array mit E-Mail-Details an und wählen den Headertyp aus, der die Nutzlast an den API-Endpunkt überträgt.

Der nächste Schritt besteht darin, ein Schlüsselwort anzugeben, nach dem in der API-Antwort für die Validierung gesucht werden soll.