Flower

← Alle Module · Dateien & System

http

Das http-Modul ruft Web-Schnittstellen (REST-APIs) und Webserver auf: es liest Daten per GET, sendet Daten per POST/PUT/PATCH, löscht per DELETE und lädt Dateien herunter oder hoch. So lassen sich Online-Dienste in einen Flower-Workflow einbinden.

Block-Einstellungen

Gelten für den ganzen Modul-Block (im Editor oben im Inspektor, in YAML direkt unter dem Modulnamen).

FeldTypPflichtBeschreibung
basis-urlText—Gemeinsame Basis-Adresse, die allen Aktionen vorangestellt wird (z.B. "https://api.beispiel.de"). Leer lassen, wenn die Aktionen vollständige URLs verwenden.
authObjekt—Anmelde-Block mit Feld 'typ' (basic | bearer | header | keine). Bei basic: 'nutzer' + 'passwort'; bei bearer: 'token'; bei header: 'name' (Default X-API-Key) + 'token'. Wird als Standard-Header an jede Anfrage gehängt.
zeitlimitZahl—Maximale Wartezeit pro Anfrage in Sekunden. Standard 30.

Aktionen

getlesend

Ruft Daten von einer Web-Adresse ab (HTTP GET) und gibt Statuscode und Antworttext zurück.

Eingaben

FeldTypPflichtBeschreibung
pfadText—Pfad bzw. URL der Anfrage (wird an die basis-url gehängt). Standard leer.
queryObjekt—Optionale Abfrageparameter als Schlüssel-Wert-Paare, die als ?a=b&c=d angehängt werden.
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen (Header) als Schlüssel-Wert-Paare.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' (HTTP-Statuscode) und 'koerper' (Antworttext); zusätzlich liegt 'status' auch flach in den Ausgaben.

postverändernd

Sendet Daten per HTTP POST an eine Adresse, z.B. um einen neuen Datensatz anzulegen.

Eingaben

FeldTypPflichtBeschreibung
pfadText—Pfad bzw. URL der Anfrage (wird an die basis-url gehängt).
koerperObjekt—Inhalt der Anfrage; ein Objekt wird als JSON gesendet, Text wird unverändert als JSON-Body verschickt.
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' und 'koerper' der Antwort; im Simulationsmodus wird nur eine Vorschau gezeigt und eine Fake-Antwort (Status 200) geliefert.

putverändernd

Ersetzt oder aktualisiert einen Datensatz per HTTP PUT.

Eingaben

FeldTypPflichtBeschreibung
pfadText—Pfad bzw. URL der Anfrage (wird an die basis-url gehängt).
koerperObjekt—Inhalt der Anfrage (Objekt als JSON oder Text).
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' und 'koerper'; im Simulationsmodus nur Vorschau plus Fake-Antwort (Status 200).

patchverändernd

Aktualisiert einzelne Felder eines Datensatzes per HTTP PATCH.

Eingaben

FeldTypPflichtBeschreibung
pfadText—Pfad bzw. URL der Anfrage (wird an die basis-url gehängt).
koerperObjekt—Inhalt der Anfrage (Objekt als JSON oder Text).
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' und 'koerper'; im Simulationsmodus nur Vorschau plus Fake-Antwort (Status 200).

deleteverändernd

Löscht eine Ressource per HTTP DELETE.

Eingaben

FeldTypPflichtBeschreibung
pfadText—Pfad bzw. URL der zu löschenden Ressource (wird an die basis-url gehängt).
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' und 'koerper'; im Simulationsmodus nur Vorschau plus Fake-Antwort (Status 204).

downloadverändernd

Lädt eine Datei von einer Web-Adresse herunter und speichert sie am angegebenen Ziel-Pfad.

Eingaben

FeldTypPflichtBeschreibung
urlTextjaAdresse der herunterzuladenden Datei (wird an die basis-url gehängt).
ziel-pfadTextjaLokaler Pfad, unter dem die heruntergeladene Datei gespeichert wird.
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

tatsaechlicher-pfadDer Pfad, unter dem die Datei tatsächlich gespeichert wurde.
groesseGröße der gespeicherten Datei in Bytes. Im Simulationsmodus wird nur eine Vorschau-Datei ins Overlay geschrieben.

uploadverändernd

Lädt eine lokale Datei per POST/PUT/PATCH zu einer Web-Adresse hoch, wahlweise als Multipart-Formular.

Eingaben

FeldTypPflichtBeschreibung
urlTextjaZiel-Adresse für den Upload (wird an die basis-url gehängt).
datei-pfadTextjaLokaler Pfad der hochzuladenden Datei. Muss existieren, sonst Fehler.
methodeText—HTTP-Methode für den Upload: POST, PUT oder PATCH. Standard POST.
feld-nameText—Bei multipart der Formularfeld-Name der Datei. Standard 'datei'.
multipartWahrheit—Wenn wahr, wird die Datei als Multipart-Formular hochgeladen, sonst als roher Body. Standard falsch.
kopfzeilenObjekt—Optionale zusätzliche HTTP-Kopfzeilen.

Ausgaben (über ergebnis:)

ergebnisObjekt mit 'status' und 'koerper' der Antwort; im Simulationsmodus nur Vorschau plus Fake-Antwort (Status 200).

Beispiele

Daten von einer REST-API abrufen

Holt mit Bearer-Token einen Bestelldatensatz per GET ab und nutzt den Antworttext weiter.

http
http get
basis-urlhttps://api.beispiel.de
auth.typbearer
auth.tokenGEHEIMER_TOKEN
pfad/bestellungen/4711
ergebnisantwort
http
(weiter)
antwort.status200
antwort.koerper{"id":4711,...}
- http:
    basis-url: "https://api.beispiel.de"
    auth:
      typ: bearer
      token: "GEHEIMER_TOKEN"
    aktionen:
      - get:
          pfad: "/bestellungen/4711"
          ergebnis: antwort

Bericht herunterladen und neuen Datensatz anlegen

Lädt eine Datei vom Server in einen lokalen Ordner und legt anschließend per POST einen Eintrag an.

http
http download
urlhttps://api.beispiel.de/berichte/monat.pdf
ziel-pfadC:\\Berichte\\monat.pdf
ergebnisdatei
http
http post
pfad/eintraege
koerper.titelMonatsbericht
ergebnisangelegt
- http:
    basis-url: "https://api.beispiel.de"
    aktionen:
      - download:
          url: "https://api.beispiel.de/berichte/monat.pdf"
          ziel-pfad: "C:\\Berichte\\monat.pdf"
          ergebnis: datei
      - post:
          pfad: "/eintraege"
          koerper:
            titel: "Monatsbericht"
          ergebnis: angelegt