Protocol

This document describes how to use a Protocol block.

Index

•

Protocol block is a block that defines the data transmission method (Protocol) with external API.

•

The available protocols are Https, Secure, and Soap.

•

Protocol blocks are commonly used with Operator > Transfer block. 

•

A block used for https communication.

Function	Explanation
method	The http(s) method to call the API. Applicable options are post, get, put, delete, patch.
end-point	The endpoint (address) of the API to call.
header	Header area of data to request to the server.
body	Body area of data to request to server.
options	Used when you need additional options for API calls

Function	Explanation
timeout	Use when setting timeout on API.
verify	If verify is required, use it in boolean form.
allow redirect	Use in Boolean form when setting whether to redirect.
proxy	Use to set up Proxy.
ssl-cert	Use to apply ssl certificates.
ssl-key	Use to apply ssl-key.

Function	Explanation
end-point	Endpoint (address) of API to call.
header	Header area of data to request to server.
body	Body area of data to request to server.
verification-code	Enter the authentication code used when communicating with Secure Protocol.
options	Used when additional options are required when calling the API.

Function	Explanation
timeout	Use if setting timeout on API.
verify	If verify is required, use it in boolean form.
allow redirect	Use boolean form when setting whether to redirect or not.

Function	Explanation
end-point	Wsdl URL, the endpoint of the API to call Soap Protocl.
header	It contains information about the data to request to the server.
soap represents header	Use to use Soap Header for authentication.
options	Use if additional options are required for API calls.
function-name	Enter the function name used when calling the API.
argument	Adds the argument used when calling the API in the HashMap manner.

Function	Explanation
ssl	Use to apply ssl certificates.
timeout	Use when setting timeout on API.

For more information on Soap Protocol, please refer to the following link.