Introduction
MDWorks offers an API that gives access to various platform features. This API is constantly evolving based on customer requests; feel free to contact us.
What is an API?
An API is a web service that lets you access some MDWorks features without having to connect to the management interface. With WSDL technology, you call MDWorks methods remotely using just a few lines of code in your favorite programming language.
What are the advantages of the MDWorks API?
Fast application development with WSDL technology and a code generator; perform several operations at once; automate and schedule tasks; build your own MDWorks management interface.
Which programming languages is SOAP compatible with?
Our web service has been tested with the following languages and libraries:
PHP: PHP5 SOAP Extension, PEAR SOAP and NuSOAP. Perl: SOAP::WSDL (with SOAP::Lite).
The API should also be compatible with the following languages (not tested): Python: SOAPpy. C#, dotNET framework 2.0.
Throughout this guide, two methods are used in the examples:
- NuSOAP, compatible with PHP4 and PHP5.
You can download the NuSOAP library here: http://dietrich.ganx4.com/nusoap/
- The PHP5 SOAP extension, available if you have compiled PHP with the following options:
--enable-libxml
--enable-soapWhat can I access with the API?
Campaign management features:
- Create a new campaign
- Edit the main parameters of a campaign
- Import a recipient file into a campaign
- Send a test
- Send a campaign
Retrieval of campaign data:
- Retrieve the bounces of a campaign
- Retrieve the openers of a campaign
- Retrieve the clickers of a campaign
- Retrieve the unsubscribers of a campaign
Statistics:
- Retrieve the statistics of a campaign
On-demand email sending:
- A function to send one or more emails on demand, without creating a campaign
- Tracking of these emails
- Display the custom statistics of a campaign