Overview
Response Parameters are API request settings used to define the format in which response data is returned.
In eZintegrations, users can specify the response type as Text, XML, or JSON. Once the response parameter is included in the API request, the backend Python API processes the request and returns the response in the selected format.
This feature helps ensure that API responses match integration and processing requirements.
When to Use
Use Response Parameters when you need control over how API responses are structured and delivered.
- Retrieving API responses in a preferred format
- Integrating with systems that require specific response types
- Processing structured or unstructured data
- Standardizing output formats across workflows
- Improving compatibility with external applications
How It Works
Response Parameters are configured as part of the API request.
When a response type is selected and sent with the request, the backend Python API interprets the parameter and formats the response accordingly.
The formatted response is then returned to the Integration Bridge pipeline for further processing.
Available Response Parameter Options
eZintegrations supports the following response formats.
- Text
- XML
- JSON
Text
Returns the API response as plain text. This option is selected by default.
XML
Returns the API response in Extensible Markup Language (XML) format for hierarchical and document-based data processing.
JSON
Returns the API response in JavaScript Object Notation (JSON) format, commonly used for structured data exchange.
User Interface Representation
The Response Parameters feature is available in the Integration Bridge Postman view and allows users to select the required response format.
Below is the UI representation of Response Parameters in the eZintegrations platform.
This interface can be accessed when configuring APIs as a Data Source, Operation, or Target inside the Integration Bridge Postman view.
Where Response Parameters Can Be Used
Response Parameters can be configured in the following Integration Bridge components.
- API Data Source
- API Operation
- API Data Target
These settings are available inside the IB Postman view for each component.
How to Configure Response Parameters
Follow these steps to configure response parameters in eZintegrations.
- Open the Integration Bridge configuration.
- Navigate to the Postman view for the required API source, operation, or target.
- Locate the Response Parameters section.
- Select the required format: Text, XML, or JSON.
- Save the configuration.
- Execute the API request to receive the formatted response.
Troubleshooting
- Ensure the selected response format is supported by the API.
- Verify that the response parameter is correctly configured.
- Check API execution logs if the format is incorrect.
- Confirm that downstream operations support the selected format.
- Use JSON format when structured parsing is required.
Frequently Asked Questions
What are Response Parameters in eZintegrations?
Response Parameters define the format in which API responses are returned, such as Text, XML, or JSON.
Which response format is selected by default?
Text format is selected by default for API responses.
Where can I configure Response Parameters?
They can be configured in the Integration Bridge Postman view for API sources, operations, and targets.
Does changing the response type affect the API request?
No. It only changes the format of the response returned by the backend API.
Can I change the response type later?
Yes. The response format can be updated at any time before executing the API request.
Notes
- Text format is selected by default.
- Select JSON for most structured integration workflows.
- Ensure format consistency across connected systems.
- Test API responses after changing response parameters.
- Document selected formats for maintenance and support.
