REST API Call


The routing process of the request that comes with the REST API Call policy and the response as a result of this forwarding process are used to change the main request.

Figure: REST API Call Secreen

  • The fields and descriptions of the REST API Call-Main Screen are listed below.

    • Call Type: There are 2 call types in the forwarding phase of the incoming request.
      • One-Way-Call (Ignore Response) option is a kind of routing where the optional response information to be redirected is not used.
      • Two-Way-Call (Process Response) option is a type of routing using the optional response information to be routed.
    • HTTP Method: The HTTP method that the API to be redirected is.
    • URL: This is the URL information of the API to be redirected.

REST API Call consists of 2 main sections; Preparing the message to be sent to the REST API - we can edit the message of the request for the API that we will redirect. For example; The API, which we will forward, will request the future request with some parameters, but if we do not have these parameters in our request, we can edit the request in this section, add the parameter to this request, and redirect it to the API in this way. is sent to the API. Arrangements can be defined here if you want to make changes to the original message according to the results of the REST API Call in the Update the original message after REST API Call.

Figure: Prepare message to be sent to the REST API

  • The areas and descriptions of the Prepare message to be sent to the REST API are listed below.

    • Prepare message to be sent to the REST API: The copy to be directed is the body of the request.

      • Clear Copied Body Content is selected, the body of the original message is completely deleted. If desired, a new message body can be created and API routing can be performed.
      • Instead of completely deleting the message body as needed, the value entered in the New Message Body field can be added by defining a variable instead of a specific message
    • Headers: Headings of the original request to be directed.

      • Delete All Copied Headers is selected, the headings of the original message are completely deleted.
      • Instead of deleting all the titles according to need, title deletion is done by specifying the titles to be deleted in the Headings field to be deleted. In the New Headings field, the header can be added to the message to be forwarded.
    • Parameters: The parameters of the original request to be directed.

      • Delete All Copied Parameters is selected, the parameters of the original message are completely deleted. If necessary, new parameters can be generated and API routing can be performed.
      • Parameter is deleted by specifying the parameters to be deleted in the Parameters field. In the New Parameters field, parameter can be added to the message to be forwarded.

Figure: Modify original message after REST API Call

  • The areas and descriptions of the Modify original message after REST API Call are listed below.

    • Modify original message after REST API Call : The copy to be directed is the body of the request.

      • Log Response: Log response from REST API call.
      • Clear Copied Body Content is selected, the body of the original message is completely deleted. If desired, a new message body can be created and API routing can be performed.
      • Instead of completely deleting the message body as needed, the value entered in the New Message Body field can be added by defining a variable instead of a specific message
    • Headers: Headings of the original request to be directed.

      • Delete All Copied Headers is selected, the headings of the original message are completely deleted.
      • Instead of deleting all the titles according to need, title deletion is done by specifying the titles to be deleted in the Headings field to be deleted. In the New Headings field, the header can be added to the message to be forwarded.
    • Parameters: The parameters of the original request to be directed.

      • Delete All Copied Parameters is selected, the parameters of the original message are completely deleted. If necessary, new parameters can be generated and API routing can be performed.
      • Parameter is deleted by specifying the parameters to be deleted in the Parameters field. In the New Parameters field, parameter can be added to the message to be forwarded.
  • In the Error Message Customization field, the Error Code and Error Message that you want to customize for this policy is entered.

  • Click Save button to save the policy.