Before getting stuck in with the technical implementation, be sure to read the introduction.
Getting started
First you'll need to decide what type of tests you're planning to start via the API.
If you're planning to test emails via the Litmus SOAP Web Service, please click here to follow instructions on creating a new email test and checking for results.
Web page tests
If you're going to be testing web pages via the Litmus SOAP Web Service, please click here to follow instructions on creating a new web page test and checking for results.
Reference documentation
The following methods are available to consumers of the Litmus Web service, we've only shown the .NET signatures here as we recommend using our RESTful API if outside the .NET or Java environment, but of course both are available in any language.
If you're using a supported IDE, the easiest way to check out our API is to reference a new Web service: http://soap.litmusapp.com/soap/wsdl
| Struct type |
Description |
| PageTest |
Contains details of a web page test, including an array of Client objects and, potentially, an array of Result objects. See the WSDL for struct definitions. |
| EmailTest |
Similar to PageTest but with properties specific to email testing. |
| Client |
Contains details of a particular client, such as the web browser: "Internet Explorer 7", of the email client: "Outlook 2007". This also includes the Client's status. |
| TestResult |
Contains details of a test result, including an instance of the Client class and a URI for each image result. |
| SpamHeader |
Client's "SpamHeaders" property returns an array of SpamHeader objects for spam tests. Contains details of the header found, including the key, rating, and a description. |
| Return type |
Method signature |
| PageTest |
CreatePageTest(String api_key, String api_passphrase, PageTest page_test) |
| PageTest |
UpdatePageTest(String api_key, String api_passphrase, PageTest page_test) |
| PageTest |
GetPageTest(String api_key, String api_passphrase, Int32 page_test_id) |
| EmailTest |
CreateEmailTest(String api_key, String api_passphrase, EmailTest email_test) |
| EmailTest |
UpdateEmailTest(String api_key, String api_passphrase, EmailTest email_test) |
| EmailTest |
GetEmailTest(String api_key, String api_passphrase, Int32 mail_test_id) |
| Clients[] |
GetPageTestClients(String api_key, String api_passphrase) |
| Clients[] |
GetMailTestClients(String api_key, String api_passphrase) |
Process for email testing
The process for running email tests is explained in more detail, as it includes a few additional steps.
Example code
C# example usage
We have provided a full C# .NET project that shows how to use the API. You can download the project from:
http://litmusapp.com/media/api/api_demo_cs.zip
VB.NET example usage
We have provided a full VB.NET project that shows how to use the API. You can download the project from:
http://litmusapp.com/media/api/api_demo_vb.zip
