Request Transformation (Mandatory Step)

In the vConnect module, this function allows you to determine the data format that the vConnect module receives from the front-end application. Based on the data format of the request, you determine if the data conversion is required. The vConnect module, as a software application service, understands data in the JSON format. It only receives, processes, and sends the data in the JSON format.

If the front-end application sends the data to the vConnect integrated API in the non-JSON format, you need to convert the non-JSON data into the JSON data format by using the “Request Transformation” function.

To use the “Request Transformation” function:

  1. Under End Point Details, find the Request Transformation list.
  1. Click the Request Transformation list and then select one of the following values:
OptionDescription
No TransformationSelect this value if the vConnect module receives the request from the application in the JSON format.
Simple RequestSelect this value if the client application issues the request in the form of a URL string or contains a body.
Complex RequestSelect this value if the API request is complex. After you select this value, the Request Transformation Template link appears. To define a template, click the Request Transformation Template link, and the Add New Template dialog box opens.  

In the Add New Template dialog box, you can define a template that will convert the non-JSON format into the JSON data format.
Response TransformationClick the check box when you want to convert the API response into the JSON format. When you click the Response Tranformation check box, the Response Transformation Template link appears. To define a template, click the Response Transformation Template link, and the Add New Template dialog box opens.
 
In the Add New Template dialog box, you can define a template that will convert the non-JSON format into the JSON data format.
Was this article helpful?
YesNo