Endpunkte
Zuletzt aktualisiert
Zuletzt aktualisiert
Eine API besteht zumeist aus mehreren Endpunkten. Die Endpunkte haben meist unterschiedliche Aufgaben wie das Lesen, Schreiben, Aktualisieren oder Löschen von Resourcen.
Um einen neuen Endpunkt zu erstellen, klicken Sie auf das Symbol am Ender der Liste.
Um einen Endpunkt zu bearbeiten, klicken Sie in der Liste darauf.
Jeder Endpunkt benötigt einen eindeutigen Namen, um ihn später in Workflows einfacher zu identifizieren. Für die Request-Methode stehen die Werte GET, POST, PUT, PATCH und DELETE zur Verfügung.
Der Pfad gibt an, wohin der Request am Server gesendet werden soll. Die vollständige URL des Endpunkts setzt sich aus dem Host der API-Spezifikation und dem hier angegebenen Pfad zusammen.
Mit dem Button Testen können Sie den Endpunkt aufrufen und überprüfen, ob er wie gewünscht funktioniert.
Spezielle Request-Header für diesen Endpunkt können ebenfalls hier definiert werden. Wenn Header auf Endpunkt- und API-Ebene den gleichen Namen haben, überschreiben die Endpunkt-Header die globalen API-Header.
Der Reiter Protokoll zeigt Ihnen wie oft dieser Endpunkt verwendet wurde. Neben dem Datum und der Ausführungszeit wird auch der Response-Code des Aufrufs angezeigt. Beim Klick auf einen Eintrag dieser Liste, werden Details angezeigt.
Im oberen Bereich des Protokolls sehen Sie das Ausführungsdatum und die Dauer des Aufrufs. Links ermöglichen den direkten Sprung zum Workflow-Protokoll, in dem dieser Aufruf stattgefunden hat. Die Navigation zum vorherigen bzw. nächsten Protokoll ist ebenfalls möglich.
Zusätzlich werden die Request-Methode, der Response-Code und die URL des Endpunkts angezeigt.
Der untere Bereich zeigt Request- und Response-Body sowie die dazugehörigen Header. Der Body kann entweder formatiert oder in seiner Originalform angezeigt werden, also genau so, wie er an den Server gesendet oder vom Server empfangen wurde.
Beim Klick auf Header werden Request- und Responser-Header angezeigt.
Der letzte Reiter Verwendung zeigt Ihnen, in welchen Workflows dieser Endpunkt in Verwendung ist.
Im mehrzeiligen Eingabefeld Inhalt kann der Request-Body definiert werden. Die Seite beschreibt, wie JSON und Platzhalter zusammen mit Variablen verwendet werden können.
