We encourage you to become familar with and to use Postman as the XML API Test Harness will be deprecated within the coming months.
XML API Test Harness
A robust XML API that gives developers access to the feature set of the Watson Campaign Automation
The Test Harness is a live test environment that is designed to be used with the XML API developer content. Use the Test Harness to test your XML. You can also see sample XML codes for different APIs to get an idea of the structure and required information needed to make the API request.
Test Harness compressed file
Download the Test Harness file.
The compressed file contains the following content:
- jsessionForm,html
- Watson Campaign Automation XML APIs – Test Harness.html
- xmlAPIServlet.html
- xmlInstructions.html
- xmlOutput.html
Areas of the Test Harness
The following list identifies the areas of the Test Harness:
- API: Gives the ability to choose the API you want to test. Once selected, you see a sample XML for that request in the XML area. You can modify the sample XML or paste your own.
- Host: Specify the Watson Campaign Automation Pod that your organization is set up on. You can find this information in the Login URL to the Watson Campaign Automation. For example, the ‘6’ in the URL, https://login6.silverpop.com, indicates the organization on Pod 6.
- jsessionid: The jsessionid is required for all User Action APIs. You see this ID in the right of the window. It is in response to the Login request.
- XML: Contains XML code for the API.
- The right side of the Test Harness shows the responses for your API requests.
API Endpoints
Overview
The URL used to specify API calls relates to the URL used when directly accessing the IBM Watson Campaign Automation with a Web browser.
API Endpoints
The URL used to specify API calls
Overview
The URL used to specify API calls relates to the URL used when directly accessing the Watson Campaign Automation with a web browser.
If your organization accesses the Watson Campaign Automation through the engage1.silverpop.com URL, you use the XML API on Pod 1 (api1.ibmmarketingcloud.com/XMLAPI). If you access the Watson Campaign Automation through the engage2.silverpop.com URL, then you use the XML APIs on Pod 2.
Submit Watson Campaign Automation API requests to URLs
Submit each API request to the URL specified in the table.
| Pod | URL |
| 1 | api1.ibmmarketingcloud.com/XMLAPI |
| 2 | api2.ibmmarketingcloud.com/XMLAPI |
| 3 | api3.ibmmarketingcloud.com/XMLAPI |
| 4 | api4.ibmmarketingcloud.com/XMLAPI |
| 5 | api5.ibmmarketingcloud.com/XMLAPI |
| 6 | api6.ibmmarketingcloud.com/XMLAPI |
| 7 | api7.ibmmarketingcloud.com/XMLAPI |
| 8 | api8.ibmmarketingcloud.com/XMLAPI |
| 9 | api9.ibmmarketingcloud.com/XMLAPI |
| A | apiA.ibmmarketingcloud.com/XMLAPI |
When I originally left a comment I appear to have clicked on the -Notify me
when new comments are added- checkbox and from now on whenever a comment is added
I receive 4 emails with the same comment. Is there a way you can remove me from that service?
Thanks!
Hello,
In the email notifications, there should be a link at the bottom that says:
Want less email? Modify your Subscription Options. With Modify your Subscription Options being a link you can click on.
Let me know if you can see this.
Thank you
Jeri
Hi tо every , as Ι am actually keen of reading thÑ–s blog’Ñ• post tÖ… be updated on a regular basis.
It contaÑ–ns pleasant stuff.
I’ve noticed the test harness submits all requests via HTTP, rather than HTTPS. This seems insecure given the XML envelope/payload calling the login method includes username and password. Does the XMLAPI respond to requests made via HTTPS?
Hi Randy,
I will get this information for you and have a response on Monday, November 13th, 2017. Thank you for your patience.
jeri
Hi Randy,
Yes, the Test Harness only submits in HTTP, and yes the XML API does accept requests made via HTTPS. However, take a look at the Postman Collection see here: https://developer.ibm.com/customer-engagement/docs/watson-marketing/ibm-engage-2/watson-campaign-automation-platform/xml-api/xml-api-postman-collection/
All of the URLs for that are already HTTPS and it only uses OAuth for authentication.
Thank you,
Jeri
Hi Randy,
Yes, the Test Harness only submits in HTTP, and yes the XML API does accept requests made via HTTPS. However, take a look at the Postman Collection see here: https://developer.ibm.com/customer-engagement/docs/watson-marketing/ibm-engage-2/watson-campaign-automation-platform/xml-api/xml-api-postman-collection/
All of the URLs for that are already HTTPS and it only uses OAuth for authentication.
Thank you,
Jeri
Can the Test Harness be updated to include the GDPR API’s?
Hi Mark,
It’s on the road map to update the Test Harness, however, I do not have a final date at this time.
Thank you
Jeri
its better to use the postman collection instead of the old test-harness:
https://developer.ibm.com/customer-engagement/docs/watson-marketing/ibm-engage-2/watson-campaign-automation-platform/xml-api/xml-api-postman-collection/
Hi Michael,
While it is better to use Postman, we do have users who still use the test harness because it’s available, so we can’t remove it just yet.
Thanks
Hello, we’d like to secure requests to your API servers from our infrastructure. Could you please let me know what IP ranges are dedicated to each Pod?
Thanks, Pavel