APICall

HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)

Stellt eine API/HTTP-Anfrage. Unterstützt das Parsen von XML/JSON-Antworten und sog. Weiterblättern (Pagination).

Über Synesty Studio für API Connector Tools

Mit Synesty als No Code Middleware verbinden Sie API Connector Tools mit anderen Schnittstellen, APIs und Systemen ohne Programmierung per Drag&Drop. Automatisieren Sie Geschäftsprozesse und Integrationen wie EDI Datenimport / Export.

Wir unterstützen Datenformate wie CSV, Excel (XLS/XLSX), XML oder JSON und ermöglichen auch HTTP-Konnektoren zu REST- oder GraphQL-APIs. Kunden nutzen es auch für Auswertungen, ETL-Aufgaben oder Feed-Optimierung.
Unser No Code Flow-Editor und unsere Low Code Scripting Tools ermöglichen kreative Anpassungen für jede Art von Integration.

Zum Add-On

Passende Vorlagen

Wird oft in Verbindung mit folgenden Add-Ons verwendet:

Über Synesty Studio für API Connector Tools

Zum Add-On

Passende Vorlagen

Wird oft in Verbindung mit folgenden Add-Ons verwendet:

Inputs

Das sind die Optionen, mit denen man den Step konfigurieren kann.

Name	Datentyp	Beschreibung	Pflichtfeld	Werte
account	ACCOUNT	Wählen sie einen HTTP account für eine Client Zertifikat-basierte Authentifizierung	Nein
host	STRING	Die URL (e.g. http://www.mywebsite.com/page.html) der ersten Anfrage (initialUrl). Nutzen Sie die ${nextUrl('...')} Funktion im parsingTemplate um weitere Anfragen zu senden. Das Protokoll kann weggelassen werden und wird standardmäßig durch http:// ersetzt.	Ja
method	STRING	Die HTTP-Methode (GET, POST, HEAD, PUT, PATCH, DELETE).	Ja	GET (Standardwert) POST HEAD PUT PATCH DELETE
username	STRING	Wenn die URL mit HTTP BASIC AUTH geschützt ist, ist dies der Benutzername.	Nein
password	STRING	Das HTTP BASIC AUTH Passwort.	Nein
errorStatusCodes	STRING	Eine kommagetrennte Liste von HTTP-Statuscodes, bei denen der Flow die Ausführung stoppt, z.B. 403,404,500. Lassen Sie das Feld leer für alle Statuscodes größer als 300.	Nein
requestBody	STRING	Optional: Versendet direkt den HTTP-Request-Body. Dies kann nützlich sein, wenn Sie mit einen XML oder JSON Webservices anbinden. Sie können die vollständige XML-Anfrage in dieses Textfeld eingeben. Nur möglich mit der HTTP-Methode POST, PATCH, PUT. Bei bodyContentType=multipart/form-data (oder Dateiupoad mit fileToUpload) kann man auch Form-Parameter übermitteln z.B. ¶m1=value1¶m2=value2 (wenn die URL/host keine Parameter hat, dann ohne das erste &-Zeichen). Es ist auch für bessere Lesbarkeit möglich, pro Zeile einen Parameter zu verwenden. Wichtig ist, dass der Wert keine Zeilenumbrüche beinhaltet. Verwenden Sie ggf. die Funktion ${urlEncode("one & one is two")}, um Werte url-encodiert zu schicken. Verwenden Sie ggf. die Funktion ${urlEncode("one & one is two")}, um Werte url-encodiert zu schicken. Für mehrzeilige Werte sollte die Freemarker <#compress> function probiert werden.	Nein
fileToUpload	FILE	Optional: Sendet die Datei direkt im Anfragetext.	Nein
fileParameterName	STRING	Optional: Der Name des HTTP-Request-Parameters, unter dem die Datei hochgeladen wird. (Standard wenn leer: 'upfile')	Nein
responseFormat	STRING	Das Datenformat der Antwort (XML/JSON).	Ja	XML (Standardwert) Die Antwort auf die Anfrage sind XML-Daten. JSON Die Antwort auf die Anfrage sind JSON-Daten. In der Regel für REST-APIs.
parsingTemplate	STRING	Template in Freemarker-Syntax, um die Antwort in ein Spreadsheet zu transformieren. Nutzen Sie die ${nextUrl('...')} Funktion zum Abruf weiterer URLs/Seiten. Wenn Sie eine nextUrl angeben, wird diese URL aufgerufen, bis keine nextUrl übergeben wird oder die Anrufgrenze (numCalls) erreicht ist. Mit der Funktion ${setVariable('key','value')} können Sie eine Variable erstellen/setzen, die im requestBody für alle Requests nach der ersten verwendet werden kann.	Nein
sourcefileCharset	STRING	Der Zeichensatz der Antwort.	Nein	Standard Der Zeichensatz der Antwort. UTF-8 UTF-16 ISO-8859-1 ISO-8859-2 ISO-8859-4 ISO-8859-5 ISO-8859-15 cp1252 (Windows-1252, ANSI) MacCentralEurope US-ASCII KOI8-R
bodyContentType	STRING	Optional: Der Content type des requestBody.	Nein	application/octet-stream application/xhtml+xml; charset=ISO-8859-1 application/json; charset=UTF-8 application/xml; charset=ISO-8859-1 text/html; charset=ISO-8859-1 text/plain; charset=ISO-8859-1 text/xml; charset=ISO-8859-1 application/x-www-form-urlencoded; charset=ISO-8859-1 multipart/form-data; charset=ISO-8859-1 text/csv; charset=UTF-8
requestHeaders	STRING	Optional: Zusätzliche HTTP-Request-Header, die dem HTTP-Request als key=value-Paare (ein Paar pro Zeile) hinzugefügt wurden.	Nein
timeoutInSeconds	STRING	Optional: HTTP-Verbindung und Read-(Socket) Zeitüberschreitung in Sekunden. Standard: 60s. Wenn der Zielhost länger als die angegebene Zeit benötig um zu Antworten schlägt der Step fehl.	Nein	Standardwert: 60
sslCertificates	STRING	Fortgeschrittenene Einstellung für HTTPS-URLs: Unter normalen Umständen führen URLs, die nur ein selbst signiertes SSL-Zertifikat haben, zu einem Fehler. Sie können den Fehler verhindern, indem Sie diesen auf 'Vertrauen Sie selbstsignierten SSL-Zertifikaten.' setzen. Dies kann jedoch ein Sicherheitsrisiko darstellen, da bösartige Websites dies missbrauchen können, um sensible Informationen zu stehlen. Verwenden Sie dies nur, wenn Sie wissen, was Sie tun!	Nein	Vertrauen Sie keine selbst signierte SSL-Zertifikate (Standard). (Standardwert) Vertrauen Sie selbstsignierten SSL-Zertifikaten (Sicherheitswarnung).
callLimit	STRING	Begrenzen Sie die Anzahl der Anrufe.	Nein
rateLimitPerSecond	STRING	Mit dieser Option können Sie die Anzahl der Aufrufe pro Sekunde begrenzen, z.B. 2 Aufrufe/s (=120 Aufrufe/Minute). Oder 0,5 Anrufe/s bedeutet 2 Sekunden Verzögerung nach jedem Aufruf. Standard: Leer = Keine Begrenzung.	Nein

Outputs

Das sind die Ergebnisse des Steps, die von nachfolgenden Steps, nach der Ausführung verwendet werden können.

Name	Datentyp	Beschreibung
output	SPREADSHEET	Die Ausgabe als Spreadsheet.
numCalls	STRING	Die maximale Anzahl der Aufrufe.
responses	STRINGLIST	Die unverarbeitete Antwort (zum Debuggen nur während der Vorschau).
sentRequests	STRINGLIST	Die gesendeten Anfragen (zum Debuggen nur während der Vorschau).

Hilfe oder Projektsupport gewünscht?

Wenn Sie Hilfe bei der Einrichtung dieses Steps benötigen oder ein Projekt umsetzen wollen, dann unterstützen Sie unsere verifizierten Partner. Partner finden

APICall wird oft in Verbindung mit folgenden Steps verwendet:

Name	Version	Beschreibung	Anwendungsfall
Mapper Mapper	-	Wandelt ein Spreadsheet in ein anderes um.
DatastoreWriter DatastoreWriter	-	Importiert Daten eines Spreadsheets in einen Datatstore.
Filter Filter	-	Kann ein Spreadheet nach einem bestimmten Ausdruck in der Freemarker-Syntax filtern und gibt nur Zeilen zurück, die der Filterbedingung entsprechen. Es wird auch ein zweites SPREADSHEET ausgegeben, das das negative Ergebnis enthält (Zeilen, die nicht der Filterbedingung entsprechen).
TextHTMLWriter TextHTMLWriter	-	Dieser Step erzeugt einen Text (STRING). Sie können damit HTML, Klartext, XML und andere textuelle Ausgabeformate erstellen. Sie können Freemarker verwenden, um die Ausgabe dynamisch zu generieren (siehe Freemarker Manual). Die Template-Sprache ermöglicht es Ihnen, die Ausgaben vorheriger Steps zur Erzeugung einer dynamischeren Ausgabe zu verwenden.	Dateien senden oder hochladen , XML Daten erstellen bzw. setzen / aktualisieren , JSON Daten erstellen bzw. setzen / aktualisieren , Nachrichten senden , Reports / Auswertungen erstellen bzw. setzen / aktualisieren
SpreadsheetUrlDownload SpreadsheetUrlDownload	-	Dieser Step kann mehrere HTTP Calls basierend auf einem SPREADSHEET oder einer SPREADSHEETLIST ausführen. Sie können den Step benutzen, um verschiedene Arten von Webservices/APIs zu verbinden. Einfache Calls und Stapel-Verarbeitung mehrerer Zeilen wird unterstützt.	HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
StopFlowIf StopFlowIf	-	Stoppt den Flow, wenn eine Bedingung wahr (TRUE) ist.
SearchDatastore SearchDatastore	-	Erlaubt die Suche in einem Datastore mit der Rückgabe von Daten als SPREADSHEET.	Reports / Auswertungen abrufen / auslesen
ColumnRemover ColumnRemover	-	Kann Spalten aus einem SPREADSHEET entfernen. Unterstützt Include/Exclude-Modus, statische und dynamische Spaltenfilter.
ExcelSheetUpdate ExcelSheetUpdate	-	Kann Daten eines Tabellenblattes einer Excel-Datei aktualiseren, erweitern (anhängen) oder ein neues Tabellenblatt erzeugen.	Dateien
FTPSingleFileDownload FTPSingleFileDownload	-	Dieser Step lädt eine einzelne Datei von FTP herunter. Derzeit können Sie einen Dateinamen Präfix und Suffix angeben, um nach den Dateien zu filtern, die Sie herunterladen möchten. Wenn es mehrere Dateien gibt, die den Kriterien entsprechen, wird nur die erste genommen. Die Dateien werden nach absteigendem Änderungsdatum auf FTP geordnet, so dass die neueste Datei aus einer Liste entfernt wird.	Dateien empfangen oder herunterladen

Weitere Steps in API Connector Tools

Name	Version	Beschreibung	Anwendungsfall
WebDAVDownload WebDAVDownload	-	Dieser Step lädt Dateien vonn einem WebDAV-Server herunter.	Dateien empfangen oder herunterladen
XMLReader XMLReader	-	Einlesen einer XML Datei in ein Spreadsheet.	XML Daten
SpreadsheetUrlDownload SpreadsheetUrlDownload	-	Dieser Step kann mehrere HTTP Calls basierend auf einem SPREADSHEET oder einer SPREADSHEETLIST ausführen. Sie können den Step benutzen, um verschiedene Arten von Webservices/APIs zu verbinden. Einfache Calls und Stapel-Verarbeitung mehrerer Zeilen wird unterstützt.	HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
WebDAVDownload WebDAVDownload	-	Dieser Step lädt Dateien vonn einem WebDAV-Server herunter.	Dateien empfangen oder herunterladen
ExtractArchive ExtractArchive	-	Dekomprimiert ein ZIP-Archiv in eine Dateiliste	Dateien empfangen oder herunterladen
WebDAVUpload WebDAVUpload	-	Dieser Step kann Dateien auf einen WebDAV-Server hochladen.	Dateien senden oder hochladen
WebDAVRename WebDAVRename	-	Dieser Step bennent eine oder mehrere Dateien auf einem WebDAV-Server um, bzw. verschiebt sie in einen existierenden Unterordner.
APICall APICall	-	Stellt eine API/HTTP-Anfrage. Unterstützt das Parsen von XML/JSON-Antworten und sog. Weiterblättern (Pagination).	HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
Archive Archive	-	Komprimiert eine einzelne DATEI oder eine DATEILISTE zu einem ZIP-Archiv
WebDAVUpload WebDAVUpload	-	Dieser Step kann Dateien auf einen WebDAV-Server hochladen.	Dateien senden oder hochladen
UrlDownload UrlDownload	-	Dieser Step greift auf eine URL zu und läd den Inhalt herunter. Das Ergebnis ist ein Wer von Typ String.	HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
WebDAVRename WebDAVRename	-	Dieser Step bennent eine oder mehrere Dateien auf einem WebDAV-Server um, bzw. verschiebt sie in einen existierenden Unterordner.
HTML2Spreadsheet HTML2Spreadsheet	-	Extrahiert HTML-Elemente aus einer Datei oder einem Spreadsheet (mit HTML-Code in einer Spalte).	Dateien
HTMLParser HTMLParser	-	Kann HTML-String einlesen und bestimmte Elemente daraus extrahieren, indem CSS- oder jQuery - Ausdrücke verwendet werden. Anschließend kann damit eine neue String-Ausgabe aus diesen extrahierten Elementen zur weiteren Verarbeitung erstellt werden.
JSONReader JSONReader	-	Liest die JSON-Datei in ein SPREADSHEET-Objekt.	JSON Daten