Overview
Response Parameters are API request settings used to define the format in which response data is returned.
In eZintegrations, users can specify whether the API response should be returned in Text, XML, or JSON format. The backend Python API processes the request and delivers the response in the selected format.
When to Use
Use Response Parameters when you need control over how API responses are structured and consumed by downstream systems.
- Retrieving API data in a preferred format
- Integrating with systems that require specific response types
- Processing text-based or structured data
- Standardizing output formats across integrations
- Improving compatibility with external applications
How It Works
Response Parameters are included in the API request configuration.
When a request is submitted with a selected response type, the backend Python API interprets the parameter and formats the response accordingly before returning it to the pipeline.
The selected format is applied consistently for the configured source, operation, or target.
Available Response Parameter Options
eZintegrations supports the following response formats.
- Text
- XML
- JSON
Text
Returns the API response as plain text without structural formatting.
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, which is 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 desired response format.
This interface is accessible when configuring APIs as a Data Source, Operation, or Target.
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 within the 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 logs if the returned format is incorrect.
- Confirm that downstream operations support the selected format.
- Use JSON format if 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 should I use?
Use JSON for structured data processing, XML for document-based integrations, and Text for plain 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 returned response, not the request itself.
Are Response Parameters mandatory?
No. They are optional and used only when specific response formats are required.
Notes
- Choose the response format based on downstream processing requirements.
- JSON is recommended for most integration workflows.
- Ensure format consistency across connected systems.
- Test API responses after changing response parameters.
- Document selected formats for maintenance and support.
