API Call

Specifies how to make the call. There are two types of call methods:

One-Way-Call: In the one-way call type, Apinizer sends the defined request information to the relevant endpoint and continues its flow without waiting for a response. When this call type is selected, Request settings become active.

Two-Way-Call: In the two-way call type, Apinizer sends the defined request information to the relevant endpoint and waits for the response to be returned from there. When a response arrives, it can use this response to update the data in its stream according to defined rules. When this call type is selected, Request and Response settings become active.

Clear Copied Body Content

This field is used to create the body of the API Call request.

If this option is not active, normally the incoming message content in the stream is sent to the endpoint as is.

If this option is active, the message body copied from the original message is cleared and the new message body is sent.

Use Message Template

This field appears when the "Clear Copied Body Content" option is activated.

It is used to determine where the value entered in the New Message Body field should be placed in the body from the original message.

Through the body of the original message, the data of the request line of the API call to be made can be manipulated. There are 2 types of data editing operations; Add/Edit and Delete.

Source refers to the original message, while Target refers to the request line in the API Call. Here, the Source field acts as the key value of the data, and the Target value acts as value.

Delete All Copied Headers

When this field is not selected, all headers from the original message are copied to the request message as it is. If selected, none will be copied.

Headers To Be Deleted

This field appears when the "Delete All Copied Headers" field is deactivated.

Only the headers added here will be removed from the copied messages.

New Headers

It is used to enter the message headers to be sent in the request message.

Remove All Copied Parameters

When this field is not selected, all parameters from the original message are copied to the request message as it is. If selected, none will be copied.

Parameters To Be Deleted

This field appears when the "Remove All Copied Parameters" field is inactive.

Only the parameters added here will be removed from the copied messages.

New Parameters

Message parameters to be sent in the request message are entered.

Enable Cache

Enables/disables cache settings.

A variable can be selected for this policy to work over a certain variable.

It is optional.

Capacity

The maximum number of responses that can be stored in the cache.

TTL

The length of time the cached response will remain in the cache. It is given in seconds. 

Cache Null Responses

Checked if null values ​​are also to be cached.

Timeout

It is the information of how long after the request will time out.

It is mandatory.

Certificate Disabled/Enabled

It is managed whether or not the certificate goes with the request.

Certificate

This field is required if the certificate has been activated. If there is no desired value in the certificate list, a new one can be created from the Add Certificate link.

Message Template Operation Type

Select which operation to apply to the body in the original message. There are three types of options:

Not Change: The Original Body will be the same as before the API Call.

Replace Original Body with API Call Response

Clear Original Body after API Call

Use Message Template

This field appears when the Clear Original Body after API Call option is activated.

If you want to create a new message body of the original message body, it is activated.

Message Template Content Type

Allows manipulation of the original body over the body of the API call response. Add/Edit and Delete operations are available on the body.

Source refers to the response line in the API Call, while Target refers to the original message.

Delete All Original Headers

When this field is selected, all message headers in the original message are deleted.

Headers To Be Deleted

This field appears when the "Delete All Original Headers" field is inactive.

Used to remove original message headers.

New Headers

This is used if a new header is to be sent after the policy is executed in the request message. The value can be taken from the response of the request or can be a fixed value.

Delete All Original Parameters

When this field is selected, all query parameters in the original message are deleted.

Parameters To Be Deleted

This field appears when the "Delete All Original Parameters" field is inactive.

It is used to remove parameters from the original parameters.

New Parameters

If a new parameter is wanted to be sent in the request message after the operation of the policy, this is used. Its value can be taken from the response of the request or can be a fixed value.