API Call

API call node is used to retrieve data from external sources, manipulate data, integrate different software systems, automate tasks, and customise applications by accessing and interacting with external services or resources .

Properties Panel

General

Field	Description	Required	Depends on
Node name	Checkout Node name	true	_
URL	A web address that specifies the location of a resource on the internet.	true	_
Method	API call method for the specified url	true	_
JSON Payload	Payload data for the API call	false	Method is 'POST'
Request headers	Headers for the API call if needed	false	-

Authentication

Field	Description	Required	Default	Depends on
Type	Authentication type (if API is authenticated)	false	No Auth	_
Username	Username for basic/digest auth	true	_	Basic Auth / Digest Auth
Password	Password for basic/digest auth	true	_	Basic Auth / Digest Auth
Header prefix	prefix used in the Authorization header of API request	false	Bearer	Bearer Token
Token	Token for API call	true	_	Bearer Token
Key	unique identifier provided to access an API	true	_	API Key
Value	corresponding secret or token associated with provided key	true	_	API Key
Add to	Headers or Params	true	_	API Key

Returns

• body - The result of the API call at runtime. You can access this using Magical Autocomplete (eg. $.<node_name>.body) in any node below this node.

• statusCode - Status of API call at runtime to check any possible errors. You can access this using Magical Autocomplete (eg. $.<node_name>.statusCode) in any node below this node.