Your first step is to setup your SOAP client with our WSDL. In .NET 2.0 and below, and Java, this is a case of adding a Web Reference. In .NET 3.0+ you'll need to follow these instructions to add a Web Reference (instead of a Service Reference) in Visual Studio. If you're using any other language and framework, please consult the documenation for the SOAP library you've chosen. In all cases, our WSDL is:

 

https://soapapi.litmusapp.com/2010-06-21/api.asmx?wsdl

 

Starting a new email test via the SOAP Web Service is a simple process of preparing a PageTest object (which contains information about the test you're about to start) and then calling the web method CreatePageTest.

 

For a complete walkthrough of this process inclding generic, language agnostic example code, please follow the guide below.

 

 

 

  1. Creating your PageTestObject
  2. Customizing  your page test
  3. Ordering your page test
  4. Using your returned test
  5. Polling for updates 
  6. Iterating through your page results