APICall Step 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).

Dokumentation im Handbuch aufrufen

Ü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

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:

Inputs

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

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 Step
Mapper
Mapper
- Converts one spreadsheet into another.
Filter Step
Filter
Filter
- Filters a Spreadsheet by a given expression and returns rows matching the filter condition.
DatastoreWriter Step
DatastoreWriter
DatastoreWriter
- Imports data from a spreadsheet into a datastore.
TextHTMLWriter Step
TextHTMLWriter
TextHTMLWriter
- This step simply generates text. You can use it to create HTML, plain text, XML and other textual output formats. You can use the Freemarker template language to dynamically generate the output (see Freemarker Manual). The template language allows you to use the outputs of previous steps for generating a more dynamic the output.
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 Step
SpreadsheetUrlDownload
SpreadsheetUrlDownload
- This step can download content from multiple URLs based on a SPREADSHEET or SPREADSHEET list. Use it to connect to various kinds of Webservice APIs.
HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
StopFlowIf Step
StopFlowIf
StopFlowIf
- Stops a Flow if condition is true.
ColumnRemover Step
ColumnRemover
ColumnRemover
- Can remove columns from a SPREADSHEET. Supports include/exclude mode, static and dynamic column filters.
SearchDatastore Step
SearchDatastore
SearchDatastore
- Allows to search a datastore and returns data as a spreadsheet. This step provides the same search features as the search form in a datastore.
Reports / Auswertungen abrufen / auslesen
UrlDownload Step
UrlDownload
UrlDownload
- This step accesses an URL and downloads the content. The result is String value.
HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
FTPSingleFileDownload Step
FTPSingleFileDownload
FTPSingleFileDownload
- This step downloads one single file from FTP. Currently you can specify a filenamePrefix and suffix to filter for the files you want to download. If there are multiple files which match the criteria only the first one is taken. The files will be ordered by descending modification date on FTP so the latest file would be taken out of a list.
Dateien empfangen oder herunterladen

Weitere Steps in API Connector Tools


Name Version Beschreibung Anwendungsfall
WebDAVDownload Step
WebDAVDownload
WebDAVDownload
- This step downloads files from a WebDAV-Server. The result is a list of files.
Dateien empfangen oder herunterladen
XMLReader Step
XMLReader
XMLReader
- Reads a XML file into a Spreadsheet object.
XML Daten
SpreadsheetUrlDownload Step
SpreadsheetUrlDownload
SpreadsheetUrlDownload
- This step can download content from multiple URLs based on a SPREADSHEET or SPREADSHEET list. Use it to connect to various kinds of Webservice APIs.
HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
WebDAVDownload Step
WebDAVDownload
WebDAVDownload
- This step downloads files from a WebDAV-Server. The result is a list of files.
Dateien empfangen oder herunterladen
ExtractArchive Step
ExtractArchive
ExtractArchive
- Extracts (decompresses) an archive (ZIP,TAR,TARGZ,GZ,7z,LZMA)-archive into a FILELIST (Unzip)
Dateien empfangen oder herunterladen
WebDAVUpload Step
WebDAVUpload
WebDAVUpload
- This step upload files to a WebDAV-Server.
Dateien senden oder hochladen
WebDAVRename Step
WebDAVRename
WebDAVRename
- This step renames a single file or a list of files on a WebDAV-Server. You can also move the file(s) into a existing subfolder.
APICall Step
APICall
APICall
- Makes an API Request. Supports parsing of XML/JSON responses and pagingation.
HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
Archive Step
Archive
Archive
- Compresses a single FILE or a FILELIST into a ZIP-archive.
WebDAVUpload Step
WebDAVUpload
WebDAVUpload
- This step upload files to a WebDAV-Server.
Dateien senden oder hochladen
UrlDownload Step
UrlDownload
UrlDownload
- This step accesses an URL and downloads the content. The result is String value.
HTTP-Requests ausführen (Daten abrufen) , HTTP-Requests ausführen (Daten senden)
HTML2Spreadsheet Step
HTML2Spreadsheet
HTML2Spreadsheet
- Extract HTML elements from a File or Spreadsheet (containing HTML-Code in one column).
Dateien
WebDAVRename Step
WebDAVRename
WebDAVRename
- This step renames a single file or a list of files on a WebDAV-Server. You can also move the file(s) into a existing subfolder.
HTMLParser Step
HTMLParser
HTMLParser
- Can Parse HTML String and can extract certain elements from it by using CSS or jQuery style expressions and then create new String output from those extracted elements for further processing.
JSONReader Step
JSONReader
JSONReader
- Reads a JSON file into a Spreadsheet object.
JSON Daten