REST

REST

Quick Start am Beispiel der Star Wars API (swapi)

Authentifizierung Typ: Keine Authentifizierung URL: https://swapi.dev/ Input Methode: get Endpunkt: api/people Output response: people

Beschreibung der Konfigurationsparameter

Planung

• Bezeichnung (optional): Titel für Workflow Element eintragen, welcher im Workflow neben dem Icon erscheint.

• Kommentar (optional): Kommentar mit weiteren Beschreibungen des Workflow Elements erstellen.

• Icon (optional): Beliebiges Icon aus der Standard Bibliothek auswählen

Authentifizierung und Konfiguration (Schritt-für-Schritt)

1

Typ der Authentifizierung

• Passwort: Authentifizierung mittels Benutzername und Passwort

• Apikey: Authentifizierung mittels API Key, dazu den API Schlüssel und Wert eingeben. Der API Key kann im Header oder als Query Parameter übergeben werden

• Bearer Token: Authentifizierung mittels Bearer Token

• Keine Authentifizierung nötig

2

URL

URL zur Ressource, an die die REST Abfrage gesendet werden soll, eingeben

3

Methode

HTTP-Befehl auswählen, der für die REST Abfrage verwendet werden soll:

• get: Abrufen einer Ressource

• post: Erstellen einer Ressource

• put: Aktualisieren einer Ressource

• delete: Löschen einer Ressource

• patch: einzelne Eigenschaften gezielt manipulieren

4

Endpunkt

Endpunkt der REST API eingeben

5

response

Variable eingeben, in welcher die response im Workflow verfügbar sein soll

Error Handling

Konfigurationen zum Umgang bei Fehlern:

• Workflow bricht automatisch ab

• Workflow läuft weiter