Overview
Testing the Data Target ensures that the configured API endpoint is reachable, properly authenticated, and capable of receiving data from the Integration Bridge.
This validation step confirms that the URL, authorization method, headers, body configuration, and pre-request scripts are correctly set before executing the full integration workflow.
When to Use
Test the Data Target after configuring the API target and before deploying or running the Integration Bridge.
- Validating API connectivity
- Verifying authentication credentials
- Testing request payload format
- Confirming headers and parameters
- Debugging integration issues
How It Works
The Test function sends a sample request to the configured target API using the defined settings.
If the API responds successfully, the configuration is valid. If an error occurs, adjustments can be made before final execution.
Steps to Test the Data Target
Step 1: Select the Target Type
Choose API as the Target Type.
Step 2: Enter the Target Name
- Search for the target name from the list of APIs available in the catalog.
- Navigate through the Marketplace to select the required API.
- Select APIs previously added to the cart in the Marketplace.
- Create a new target if the desired API is not available.
Step 3: Enter the Business Object
- Select from the list of existing business objects.
- For a newly created API target, manually enter the business object name.
Step 4: Enter the URL and Predefined Fields
- For APIs added from the catalog, the URL and predefined fields auto-populate.
- For new APIs, manually enter required details.
- Select the authorization method: No Auth, Basic Auth, or OAuth 2.0.
- Provide credentials based on the selected authorization method.
- Configure additional settings such as Headers, Body, and Pre-request Script if required.
Step 5: Test the API
Click the Test option to execute the configured API request.
Review the response status and message to confirm successful configuration.
Expected Result
A successful response confirms that:
- The API endpoint is reachable.
- Authentication is valid.
- The request payload format is accepted.
- The Data Target configuration is correct.
Frequently Asked Questions
Why should I test the Data Target before running the integration?
Testing verifies connectivity, authentication, and configuration accuracy before processing live data.
What happens if the test fails?
Review the URL, authorization credentials, headers, body configuration, and pre-request script for errors and test again.
Can I test a newly created API target?
Yes. Newly created API targets can be tested after entering required details manually.
Does testing send actual data?
Testing sends a request using the configured settings to validate connectivity and response behavior.
Can I change the authorization method after testing?
Yes. Authorization methods can be modified and retested before final execution.
Notes
- Ensure correct credentials before testing.
- Verify business object mapping.
- Confirm correct HTTP method selection.
- Use testing in staging environments before production deployment.
- Resolve all errors before activating the Integration Bridge.
