APICall

execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests

Makes an API/HTTP-Request. Supports parsing of XML/JSON responses and pagingation.

View manual

Why Synesty?

  • Central middleware for all integrations, connectors and automation of business processes
  • No coding required - just Drag&Drop and configuration
  • Professional support with quick responses
Sign up for FREE Demo

Related templates

Why Synesty?

  • Central middleware for all integrations, connectors and automation of business processes
  • No coding required - just Drag&Drop and configuration
  • Professional support with quick responses
Sign up for FREE Demo

Related templates

Inputs

Name Type Description Required Values
account ACCOUNT Select a HTTP account for client certificate based authentication No
host STRING This is the URL (e.g. http://www.mywebsite.com/page.html) which will be downloaded. The protocol can be ommitted and will be replaced by http:// by default. Yes
method STRING The HTTP Method (GET, POST, HEAD, PUT, PATCH, DELETE). Yes
  • GET (Default)
  • POST
  • HEAD
  • PUT
  • PATCH
  • DELETE
username STRING If the URL is protected with HTTP BASIC AUTH, this is the username. No
password STRING The HTTP BASIC AUTH password. No
errorStatusCodes STRING A comma separated list of http status codes for which flow stops execution, e.g. 403,404,500. Leave empty for all status codes greater than 300. No
requestBody STRING Optional: Directly sent the HTTP request body. This can be useful when talking to XML or JSON webservices where you can insert the full XML Request in this textfield. Only possible with POST, PUT, PATCH HTTP method. When bodyContentType=multipart/form-data (or you use fileToUpload) then you can send form parameters like &param1=value1&param2=value2 (if your URL/host does not have any parameters then your first parameter must not have the & character. It is also possible to add each parameter on a new line. Make sure each parameter/value is on a single line. If necessary use the function ${urlEncode("one & one is two")} to send values url-encoded. If necessary use the function ${urlEncode("one & one is two")} to send values url-encoded. For multi-line values consider the Freemarker <#compress> function to remove linebreaks. No
fileToUpload FILE Optional: Directly sent this file in request body. No
fileParameterName STRING Optional: The name of the HTTP-request-parameter under which the file is uploaded. (Default if empty: 'upfile') No
responseFormat STRING The format of the response (XML/JSON). Yes
  • XML (Default)
    The response of the request is XML data.
  • JSON
    The response of the request is JSON data. Usually for REST-APIs.
parsingTemplate STRING Template in Freemarker syntax to transform the response into a Spreadsheet. Use the ${nextUrl('...')} function for pagination. Whenever you specify a nextUrl then this url will be called until nextUrl is empty or the call limit is reached. You can use the ${setVariable('key','value')} function to create/set a variable which can be used in the requestBody for all requests after first one. No
sourcefileCharset STRING The characterset of the response. Default: [AUTO-DETECT] (only for XML) No
  • Default
    If you get broken characters please select a more specific characterset instead.
  • 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: The content type of the requestBody. No
  • 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: Additional HTTP request headers added to the HTTP-Request as key=value pairs (one pair per line). No
timeoutInSeconds STRING Optional: HTTP Connection and read-(socket) timeout in seconds. Default: 60s. If the target host takes longer to respond than the timeoutInSeconds, then the step will fail with an error. No Default: 60
sslCertificates STRING Expert Setting for HTTPS-URLs: Under normal circumstances, URLs which have only a self-signed SSL certificate will result in an error. You can prevent the error by setting this to 'Trust self-signed SSL Certificates'. But this can be a security risk, because malicious sites can abuse this to steal sensitive information. Only use this, if you know what you are doing!!! No
  • Do not trust self-signed SSL Certificates (default) (Default)
  • Trust self-signed SSL Certificates (Security Warning)
callLimit STRING Limit the number of calls. No Default: 10
rateLimitPerSecond STRING Rate Limit allows you to limit the number of calls per second, e.g. 2 calls/s (=120 calls/minute). Or 0.5 calls/s means 2 seconds delay after each call. Default: Empty = No limit. No

Outputs

Name Type Description
output SPREADSHEET The output as a Spreadsheet.
numCalls STRING The number of calls.
responses STRINGLIST The raw responses (for debugging only during preview).
sentRequests STRINGLIST The submitted requests (for debugging only during preview).

Need help or project support?

If you need help during setup of this step or a project then reach out to our certified partners. Find Partners

More steps steps in Professional


Name Version Description Use-Case
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.
FTPRename
FTPRename
- This step renames a list of files on FTP. Currently there are two modes which are support: 1. Rename a single file to a new fileName or prefix the oldfilename Here you need to specify the input parameter remoteFilename and the parameter newRemoteFilenamePrefix or newRemoteFilename 2. Rename a list of files using a prefix which will be infront of the new Filename (e.g. [DONE_]OLDFILENAME.xml) Here you need to input a List which currently needs to be the result of another service which is executed before this step.
send or upload Files
FlowTrigger
FlowTrigger
- A step which can trigger another flow asynchronously. The run will count as a separate run. It can be used to execute a sub-process with a pause or delay.
WebDAVUpload
WebDAVUpload
- This step upload files to a WebDAV-Server.
send or upload Files
XMLReader
XMLReader
- Reads a XML file into a Spreadsheet object.
XML Data
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.
execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests
JSONReader
JSONReader
- Reads a JSON file into a Spreadsheet object.
JSON data
UrlDownload
UrlDownload
- This step accesses an URL and downloads the content. The result is String value.
execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests
XMLSplitter
XMLSplitter
- Split a large XML File into multiple smaller XML files.
XML Data
KeyValueSpreadsheet
KeyValueSpreadsheet
- Converts a Spreadsheet into a special Spreadsheet which can be used as a key-value map.
FlowExecutingStep
FlowExecutingStep
- A step which can execute another Flow.
Archive
Archive
- Compresses a single FILE or a FILELIST into a ZIP-archive.
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.
receive or download Files
FTPDownload
FTPDownload
- This step downloads files from FTP. The result is a list of files. Currently you can specify a filenamePrefix and suffix to filter for the files you want to download.
receive or download Files
AddUpdateMappingset
AddUpdateMappingset
- Creates or updates a mappingset based on 2 columns of a Spreadsheet.
EmailSend
EmailSend
- This step sends a single email.
send Messages
ToList
ToList
- Creates a list of serveral inputs.
APICall
APICall
- Makes an API Request. Supports parsing of XML/JSON responses and pagingation.
execute and receive data by HTTP-Requests , execute and upload data by HTTP-Requests
FTPUpload
FTPUpload
- This step uploads a list of files to a FTP.
send or upload Files
XMLReaderVisual
XMLReaderVisual
- Reads XML file into a Spreadsheet object.
fetch XML Data
WebDAVDownload
WebDAVDownload
- This step downloads files from a WebDAV-Server. The result is a list of files.
receive or download Files
ExtractArchive
ExtractArchive
- Extracts (decompresses) an archive (ZIP,TAR,TARGZ,GZ,7z,LZMA)-archive into a FILELIST (Unzip)
receive or download Files
FTPRemove
FTPRemove
- Deletes a file or filelist from FTP or SFTP server. Hinweis: Die Benutzung des FTPRemove Steps erfolgt auf eigene Gefahr. Falsche Konfiguration kann zu Datenverlust führen. Wir übernehmen keine Haftung für Datenverlust der durch falsche Konfiguration entsteht. Wir empfehlen stattdessen den Step FTPRename zu nutzen, und die Dateien z.B. in einen "archive" Ordner zu verschieben und mit einem Datum zu versehen und diesen regelmäßig per Hand zu sichten und ggf. zu löschen. Das ist gängige Praxis und hat den Vorteil, dass sie eine Historie sowie Backup der verarbeiteten Daten haben.
JSONReaderVisual
JSONReaderVisual
- Reads JSON into a Spreadsheet object providing a simple graphical User-Interface.
fetch JSON data