This page collects resources often needed when developing interfaces to eC-messenger.

SynchronousSoapAPI#

WSDL + WSDL for SSL Access

This File should be enough to get your IDE connected. More on SSL Certificates.

Documentation

Find it in JavaDoc-Style or SOAP-Style

For more info please check SynchronousSoapAPI.

Here and here (with NUSOAP) is some PHP Example code, illustrating the use of this API.

Francois Castets provided this PHP example, that illistrates the use of functions like CreateOrUpdateUserMemberByEmail or SendParametrizedSingleMessageToUser and features the packing of user data into XML too. It uses the build in SOAP features of PHP>5.2.

XML Definitions#

eCircle WebService

Top-Level W3C Schema definition that references or includes most of the following W3C schema definitons.

eCircle XML Schema

This W3C Schema includes the defintions for the group-control element (base of the Asynchronous API) and other higher-level elements such as reports.

eCircle XML Types

Contains base type which are often used to implement higher level elements. You'll find the deinition of users, group and members-Elements here as well as the definitions of the different address-types.

XML Schema HTML Documentation

This is a XMLSpy-generated complete HTML documentation of our Top-Level Schema (eC-M Version 6.0). Download this, extract this to a local directory and point your browser to the file index.html.We update this reference periodically to reflect the currently installed eC-messenger. Be sure to check for a latest version.

Some XML Nodes explained#

SampleControlXML; Example for a more complex control message, that creates a new group, adds recipients, does a sendout, schedules reports and is finally deleted. This process is described in more Detail under AsynchronousAPI

Some base types for eC-messenger

XMLUserType - XMLGroupType - XMLAddressType - XMLMessageType

Asynchronous SOAP PHP5 Example#

This example was generously contributed by Jan Steemann from http://globalpark.com. It contains utilities to assemble a XML message and to hand it over to our SOAP receiver, using plain HTTP. Read the file ABOUT for instructions on how to use it. Also make sure, to check if the generated XML is still valid against our latest schema.

Asynchronous SOAP Java Examples#

soap-client.zip contains code to send a messages to eC-messenger, using the AsynchronousAPI] mechanisms. You can learn from it how to do authentication, how to assemble a message and how to get SSL to work. The SSL example seems to be not working currently. It still illustrates the general mechanism of using SSL soap-server.zip contains code to receive messages from eC-messenger sent by the SOAP protocol.

Example Java Servlet to receive eC-messenger generated XML messages.#

This simple code shows how you may receive notification and report messages from eC-messenger. All it needs is a receiver script on a HTTP Server.

AdServer API#

Beta Release AdserverAPI