HTTP-Request-Knoten#
Der HTTP-Request-Knoten ist einer der vielseitigsten Knoten in Localmind Automate. Er ermöglicht es Ihnen, HTTP-Anfragen zu stellen, um Daten von jeder App oder jedem Dienst mit einer REST-API abzufragen.
Wenn Sie diesen Knoten verwenden, erstellen Sie einen REST-API-Aufruf. Sie benötigen ein grundlegendes Verständnis der API-Terminologie und -Konzepte.
Es gibt zwei Möglichkeiten, eine HTTP-Anfrage zu erstellen: Konfigurieren Sie die Knotenparameter oder importieren Sie einen Curl-Befehl.
Credentials
Informationen zum Einrichten der Authentifizierung finden Sie unter HTTP-Request-Zugangsdaten.
Knotenparameter#
Methode#
Wählen Sie die Methode aus, die für die Anfrage verwendet werden soll:
- DELETE
- GET
- HEAD
- OPTIONS
- PATCH
- POST
- PUT
URL#
Geben Sie den Endpunkt ein, den Sie verwenden möchten.
Authentifizierung#
Localmind Automate empfiehlt die Verwendung der Option Vordefinierter Anmeldeinformationstyp, wenn diese verfügbar ist. Sie bietet eine einfachere Möglichkeit zum Einrichten und Verwalten von Anmeldeinformationen im Vergleich zur Konfiguration generischer Anmeldeinformationen.
Vordefinierte Anmeldeinformationen#
Verwenden Sie Vordefinierter Anmeldeinformationstyp für benutzerdefinierte Operationen ohne zusätzlichen Setup. Weitere Informationen finden Sie unter Benutzerdefinierte API-Operationen.
Generische Anmeldeinformationen#
Anmeldeinformationen für Integrationen, die von Localmind Automate nicht unterstützt werden. Sie müssen den Authentifizierungsprozess manuell konfigurieren, einschließlich der Angabe der erforderlichen API-Endpunkte, der erforderlichen Parameter und der Authentifizierungsmethode.
Sie können eine der folgenden Methoden auswählen:
- Basic auth
- Custom auth
- Digest auth
- Header auth
- OAuth1 API
- OAuth2 API
- Query auth
Weitere Informationen zum Einrichten der einzelnen Anmeldeinformationstypen finden Sie unter HTTP-Request-Zugangsdaten.
Abfrageparameter senden#
Abfrageparameter fungieren als Filter für HTTP-Anfragen. Wenn die API, mit der Sie interagieren, diese unterstützt und die von Ihnen gestellte Anfrage einen Filter benötigt, aktivieren Sie diese Option.
Geben Sie Ihre Abfrageparameter an, indem Sie eine der verfügbaren Optionen verwenden:
- Verwendung der folgenden Felder: Geben Sie Name/Wert-Paare von Abfrageparametern ein. Um weitere Name/Wert-Paare für Abfrageparameter einzugeben, wählen Sie Parameter hinzufügen. Der Name ist der Name des Felds, nach dem Sie filtern, und der Wert ist der Filterwert.
- Verwendung von JSON: Geben Sie JSON ein, um Ihre Abfrageparameter zu definieren.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
Header senden#
Verwenden Sie diesen Parameter, um Header mit Ihrer Anfrage zu senden. Header enthalten Metadaten oder Kontext zu Ihrer Anfrage.
Header angeben mit einer der verfügbaren Optionen:
- Verwendung der folgenden Felder: Geben Sie Name/Wert-Paare von Header-Parametern ein. Um weitere Name/Wert-Paare für Header-Parameter einzugeben, wählen Sie Parameter hinzufügen. Der Name ist der Header, den Sie festlegen möchten, und der Wert ist der Wert, den Sie für diesen Header übergeben möchten.
- Verwendung von JSON: Geben Sie JSON ein, um Ihre Header-Parameter zu definieren.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
Body senden#
Wenn Sie einen Body mit Ihrer API-Anfrage senden müssen, aktivieren Sie diese Option.
Wählen Sie dann den Body-Inhaltstyp aus, der am besten zum Format des Body-Inhalts passt, den Sie senden möchten.
Form URLencoded#
Verwenden Sie diese Option, um Ihren Body als application/x-www-form-urlencoded
zu senden.
Body angeben mit einer der verfügbaren Optionen:
- Verwendung der folgenden Felder: Geben Sie Name/Wert-Paare von Body-Parametern ein. Um weitere Name/Wert-Paare für Body-Parameter einzugeben, wählen Sie Parameter hinzufügen. Der Name sollte der Name des Formularfelds sein, und der Wert ist der Wert, den Sie für dieses Feld festlegen möchten.
- Verwendung eines einzelnen Felds: Geben Sie Ihre Name/Wert-Paare in einem einzelnen Body-Parameter im Format
fieldname1=value1&fieldname2=value2
ein.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
Form-Data#
Verwenden Sie diese Option, um Ihren Body als multipart/form-data
zu senden.
Konfigurieren Sie Ihre Body-Parameter, indem Sie den Parametertyp auswählen:
- Wählen Sie Form Data, um Name/Wert-Paare einzugeben.
- Wählen Sie Localmind Automate Binärdatei, um den Body aus einer Datei abzurufen, auf die der Knoten Zugriff hat.
- Name: Geben Sie die ID des Felds ein, das festgelegt werden soll.
- Name des Eingabedatenfelds: Geben Sie den Namen des eingehenden Felds ein, das die binären Dateidaten enthält, die Sie verarbeiten möchten.
Wählen Sie Parameter hinzufügen, um weitere Parameter einzugeben.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
JSON#
Verwenden Sie diese Option, um Ihren Body als JSON zu senden.
Body angeben mit einer der verfügbaren Optionen:
- Verwendung der folgenden Felder: Geben Sie Name/Wert-Paare von Body-Parametern ein. Um weitere Name/Wert-Paare für Body-Parameter einzugeben, wählen Sie Parameter hinzufügen.
- Verwendung von JSON: Geben Sie JSON ein, um Ihren Body zu definieren.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
Localmind Automate Binärdatei#
Verwenden Sie diese Option, um den Inhalt einer in Localmind Automate gespeicherten Datei als Body zu senden.
Geben Sie den Namen des eingehenden Felds, das die Datei enthält, als Name des Eingabedatenfelds ein.
Detaillierte Anleitungen zur Formatierung der Datei finden Sie in der API-Dokumentation Ihres Dienstes.
Raw#
Verwenden Sie diese Option, um Rohdaten im Body zu senden.
- Inhaltstyp: Geben Sie den
Content-Type
-Header ein, der für den Rohdateninhalt verwendet werden soll. Eine vollständige Liste der MIME-Inhaltstypen finden Sie in der IANA-Dokumentation zu Medientypen. - Body: Geben Sie den zu sendenden Rohdateninhalt ein.
Detaillierte Anleitungen finden Sie in der API-Dokumentation Ihres Dienstes.
Knotenoptionen#
Wählen Sie Option hinzufügen, um diese Optionen anzuzeigen und auszuwählen. Optionen sind für alle Parameter verfügbar, sofern nicht anders angegeben.
Array-Format in Abfrageparametern#
Option availability
Diese Option ist nur verfügbar, wenn Sie Abfrageparameter senden aktivieren.
Verwenden Sie diese Option, um das Format für Arrays zu steuern, die in Abfrageparametern enthalten sind. Wählen Sie aus diesen Optionen:
- Keine Klammern: Arrays werden als Name=Wert für jedes Element im Array formatiert, zum Beispiel:
foo=bar&foo=qux
. - Nur Klammern: Der Knoten fügt nach jedem Array-Namen eckige Klammern hinzu, zum Beispiel:
foo[]=bar&foo[]=qux
. - Klammern mit Indizes: Der Knoten fügt nach jedem Array-Namen eckige Klammern mit einem Indexwert hinzu, zum Beispiel:
foo[0]=bar&foo[1]=qux
.
Informationen zur Auswahl der richtigen Option finden Sie in der API-Dokumentation Ihres Dienstes.
Batch-Verarbeitung#
Steuern Sie, wie große Mengen von Eingabeelementen in Batches verarbeitet werden:
- Elemente pro Batch: Geben Sie die Anzahl der Eingabeelemente an, die in jedem Batch enthalten sein sollen.
- Batch-Intervall: Geben Sie die Zeit an, die zwischen den einzelnen Anfragen-Batches in Millisekunden gewartet werden soll. Geben Sie 0 für kein Batch-Intervall ein.
SSL-Probleme ignorieren#
Standardmäßig lädt Localmind Automate die Antwort nur herunter, wenn die SSL-Zertifikatsvalidierung erfolgreich ist. Wenn Sie die Antwort auch dann herunterladen möchten, wenn die SSL-Zertifikatsvalidierung fehlschlägt, aktivieren Sie diese Option.
Kleinbuchstaben-Header#
Wählen Sie aus, ob Header-Namen in Kleinbuchstaben umgewandelt werden sollen (aktiviert, Standard) oder nicht (deaktiviert).
Weiterleitungen#
Wählen Sie aus, ob Weiterleitungen gefolgt werden soll (standardmäßig aktiviert) oder nicht (deaktiviert). Wenn diese Option aktiviert ist, geben Sie die maximale Anzahl von Weiterleitungen ein, denen die Anfrage in Max. Weiterleitungen folgen soll.
Antwort#
Verwenden Sie diese Option, um einige Details über die erwartete API-Antwort festzulegen, einschließlich:
- Antwort-Header und -Status einschließen: Standardmäßig gibt der Knoten nur den Body zurück. Aktivieren Sie diese Option, um die vollständige Antwort (Header und Antwortstatuscode) sowie den Body zurückzugeben.
- Niemals Fehler: Standardmäßig gibt der Knoten nur dann Erfolg zurück, wenn die Antwort mit einem 2xx-Code zurückgegeben wird. Aktivieren Sie diese Option, um unabhängig vom zurückgegebenen Code Erfolg zurückzugeben.
- Antwortformat: Wählen Sie das Format aus, in dem die Daten zurückgegeben werden sollen. Wählen Sie aus:
- Automatische Erkennung (Standard): Der Knoten erkennt und formatiert die Antwort basierend auf den zurückgegebenen Daten.
- Datei: Wählen Sie diese Option, um die Antwort in eine Datei zu speichern. Geben Sie den Feldnamen ein, in dem die Datei zurückgegeben werden soll, in Ausgabe in Feld speichern.
- JSON: Wählen Sie diese Option, um die Antwort als JSON zu formatieren.
- Text: Wählen Sie diese Option, um die Antwort als Nur-Text zu formatieren. Geben Sie den Feldnamen ein, in dem die Datei zurückgegeben werden soll, in Ausgabe in Feld speichern.
Paginierung#
Verwenden Sie diese Option, um Ergebnisse zu paginieren, was nützlich ist, um Abfrageergebnisse zu verarbeiten, die zu groß sind, als dass die API sie in einem einzigen Aufruf zurückgeben könnte.
Untersuchen Sie zuerst die API-Daten
Einige Optionen für die Paginierung erfordern Kenntnisse der Daten, die von der von Ihnen verwendeten API zurückgegeben werden. Bevor Sie die Paginierung einrichten, überprüfen Sie entweder die API-Dokumentation oder führen Sie einen API-Aufruf ohne Paginierung durch, um die zurückgegebenen Daten anzuzeigen.
Paginierung verstehen
Paginierung bedeutet, einen großen Datensatz in mehrere Seiten aufzuteilen. Die Datenmenge auf jeder Seite hängt von dem von Ihnen festgelegten Limit ab.
Beispielsweise führen Sie einen API-Aufruf an einen Endpunkt namens /users
durch. Die API möchte Informationen zu 300 Benutzern zurücksenden, aber dies sind zu viele Daten, als dass die API sie in einer Antwort senden könnte.
Wenn die API die Paginierung unterstützt, können Sie die Daten inkrementell abrufen. Rufen Sie dazu /users
mit einem Paginierungslimit und einer Seitenzahl oder URL auf, um der API mitzuteilen, welche Seite gesendet werden soll. Nehmen wir in diesem Beispiel an, Sie verwenden ein Limit von 10 und beginnen auf Seite 0. Die API sendet die ersten 10 Benutzer in ihrer Antwort. Anschließend rufen Sie die API erneut auf und erhöhen die Seitenzahl um 1, um die nächsten 10 Ergebnisse zu erhalten.
Konfigurieren Sie die Paginierungseinstellungen:
- Paginierungsmodus:
- Aus: Deaktivieren Sie die Paginierung.
- Parameter in jeder Anfrage aktualisieren: Verwenden Sie diese Option, wenn Sie Parameter für jede Anfrage dynamisch festlegen müssen.
- Antwort enthält nächste URL: Verwenden Sie diese Option, wenn die API-Antwort die URL der nächsten Seite enthält. Verwenden Sie einen Ausdruck, um Nächste URL festzulegen.
Beispielkonfigurationen finden Sie unter Localmind Automate Rezeptbuch für den HTTP-Request-Knoten | Paginierung.
Localmind Automate bietet integrierte Variablen für die Arbeit mit HTTP-Knotenanfragen und -Antworten bei Verwendung der Paginierung:
Variable | Description |
---|---|
$pageCount |
The pagination count. Tracks how many pages the node has fetched. |
$request |
The request object sent by the HTTP node. |
$response |
The response object from the HTTP call. Includes $response.body , $response.headers , and $response.statusCode . The contents of body and headers depend on the data sent by the API. |
API differences
Different APIs implement pagination in different ways. Check the API documentation for the API you're using for details. You need to find out things like:
- Does the API provide the URL for the next page?
- Are there API-specific limits on page size or page number?
- The structure of the data that the API returns.
Proxy#
Verwenden Sie diese Option, wenn Sie einen HTTP-Proxy angeben müssen.
Geben Sie den Proxy ein, den die Anfrage verwenden soll.
Timeout#
Verwenden Sie diese Option, um festzulegen, wie lange der Knoten auf das Senden von Antwortheadern durch den Server warten soll (und den Antwortbody zu starten). Der Knoten bricht Anfragen ab, die diesen Wert für die erste Antwort überschreiten.
Geben Sie die Timeout-Zeit in Millisekunden ein, die gewartet werden soll.
Curl-Befehl importieren#
curl ist ein Befehlszeilentool und eine Bibliothek zum Übertragen von Daten mit URLs.
Sie können curl verwenden, um REST-APIs aufzurufen. Wenn die API-Dokumentation des Dienstes, den Sie verwenden möchten, curl-Beispiele enthält, können Sie diese aus der Dokumentation in Localmind Automate kopieren, um den HTTP-Request-Knoten zu konfigurieren.
Importieren Sie einen Curl-Befehl:
- Wählen Sie auf der Registerkarte Parameter des HTTP-Request-Knotens die Option cURL importieren aus. Das Modal cURL-Befehl importieren wird geöffnet.
- Fügen Sie Ihren Curl-Befehl in das Textfeld ein.
- Wählen Sie Importieren aus. Localmind Automate lädt die Anfragekonfiguration in die Knotenfelder. Dadurch werden alle vorhandenen Konfigurationen überschrieben.