SOAP Method Configuration
In this tab, policies, protocol conversion settings, and SOAP method management operations can be performed for the selected API Proxy.
SOAP Method Operations
Each API Proxy has its own methods that act as proxies for the methods of the Backend API placed in front of it. If the API Proxy has been created by providing the address of a WSDL file or by uploading such a file, a method with the same name is automatically created in the API Proxy for each method that exists in that file.
- One or more new methods have been added to the Backend API
- One or more methods have been deleted from the Backend API
- The name of one or more methods in the Backend API is desired to be hidden from clients
- One or more methods in the Backend API are desired to be completely or temporarily closed to client access
Selecting SOAP Method
When the name of any method in the method list is clicked, that method is selected and the interface is updated accordingly.- In the list, the color changes to indicate which method is selected.
- In the upper middle section, which method is selected is shown.
- In the lower middle section, links to operations that can be performed for this method are displayed.
- On the right side, which method of the Backend API the selected method is related to is visible.
Updating SOAP Method Settings
Only method update operations can be performed in SOAP type API Proxies. The settings that can be made for methods of SOAP type API Proxy are different from REST type settings, and an image containing these settings is shown below:
SOAP Method Settings Fields
| Field | Description |
|---|---|
| SOAP Action | When the WSDL file is parsed, the SOAPAction value specified for the method is automatically obtained. However, to use a different value for any reason, the value in this field can be changed. |
| Enable Download | If the result returned from the API Method/Endpoint is of Byte Array type, this option is marked for the result to be handled as a file. Otherwise, the content is returned to the client as encoded text. To decide whether the result is Byte Array, it is checked whether the Content Type Header value is in the “Byte Array Types” list in system settings. If it is in this list, it is decided that the result is of Byte Array type. |
| If enabled, Base64 Encoded Text is used For Compressed Response(by Accept-Encoding header value), default value is Byte Array | It is decided whether the response message to be returned from this method is compressed by checking whether the values gzip, deflate, or br are in the Accept-Encoding value. If one of these values exists, the status of the response message is compressed. If the returned message is in compressed state and the response is Byte Array type and: • If this option of the method is active, the returned message is compressed as Byte Array and returned to the client. • If this option of the method is passive, the returned message is encoded with Base64 and converted to text, then the text version is compressed and returned to the client. |
| Skip for Re-Parse | When this field is marked, it indicates that this method should not be updated when the API Proxy is subjected to a “re-parse” operation. For example, even if this method has been deleted from the specification file, it remains undeleted after the re-parse operation. |
| WSA Settings | Thanks to this section, WS-Security Addressing settings can be activated separately for each method. When activated, the related WSA values are added to the SOAP message. |
| Must Understand | The setting of the “Must Understand” value is made. |
| Version | Selection of the WSA version to be used is made. |
| Add Default Action | Ensures that the default action determined when the WSDL file is parsed is added to the SOAP message. When activated, the action expression below disappears. |
| Action | This field is used to add a customized action to the SOAP message. |
| Add Default To | Ensures that the default “To” information determined when the WSDL file is parsed is added to the SOAP message. When activated, the “To” expression below disappears. |
| To | This field is used to add customized “To” information to the SOAP message. |
| Reply To | This field is used to add customized reply “To” information to the SOAP message. |
| Generate Message ID | This field is activated to add a different generated Message ID for each message to the SOAP message. |
| Message ID | This field is activated to add a fixed Message ID for each message to the SOAP message. |
| From | This field is used to add customized “From” information to the SOAP message. |
| Fault To | This field is used to add customized fault “To” information to the SOAP message. |
| Relates To | This field is used to add customized fault relation information to the SOAP message. |
| RelationShip Type | This field is used to add customized fault relationship type information to the SOAP message. |
| Cache Settings | If this setting is activated, method/endpoint-based cache settings are activated. |
| Cache Key Type | There are two options for Cache Key Type: • Use Query Params: Used to determine the key to be created for caching based on HTTP Query parameters in the request. For example, when the query parameter is /methodName?param1=value1¶m2=value2, the key to be kept in cache consists of the value param1=value1¶m2=value2, and when a request comes in this way again, the result in cache is returned.• Create Custom Key: Used to create the key to be created for caching with the fields to be selected in the request. When this value is selected, the key is created with the fields specified in the “Variable List” table. |
| Variable List | This field becomes active if “Create Custom Key” is selected as the Cache Key Type. With this option, the cache key to be created is made with the combination of fields to be specified from the header, parameter, or body sections of the request message. Custom key can be created using Variable. |
| Capacity | The maximum number of responses that can be stored in cache. |
| Invalidation Requires Authn | Selected if authorization is required to invalidate the cache. |
| Handling Action | If authorization is required to invalidate the cache, the action to be taken for unauthorized requests is selected: • Continue: If this option is selected, when one of the values no-cache, no-store, or max-age=0 is sent in the Cache-Control header information, if the sender is not authorized, it continues to work as if this value was not sent.• Stop: If this option is selected, when one of the values no-cache, no-store, or max-age=0 is sent in the Cache-Control header information, if the sender is not authorized, it stops the flow and returns an error message.This field becomes active when the “Invalidation Requires Authn” option is marked. |
| TTL (seconds) | The duration for which the cached response will be valid is entered in seconds. |
| Cache Null Value | Marked if empty values are also desired to be cached. |
Deleting SOAP Method
The Delete Method link is clicked. After the confirmation process, the method is deleted.Temporarily Disabling SOAP Method
It is possible to close a method to access without deleting it. For this, the Disable Method link is clicked. When the link is clicked, the method is disabled, and along with this, the following changes occur in the interface.- The icon next to the method changes to show that the method is out of use.
- The Disable Method link disappears. Instead, the Enable Method link appears.
