• More code can be found on GitHub  
• Follow this link to the REST API

1^st March 2016

Version 1.0

CONTENTS

OVERVIEW... 

API ACCESS. 

API KEY. 

LOGIN CREDENTIALS. 

API REQUEST PARAMETER ORDER. 

GENERIC ERROR RESPONSE CODES. 

CONTACT OPERATIONS. 

Contacts.AddContact 

Contacts.GetContactsByGroup. 

GROUP OPERATIONS. 

Groups.AddContactToGroup. 

Groups.RemoveContactFromGroup. 

Groups.GetListing. 

Groups.EditGroup. 

CAMPAIGN OPERATIONS.

Campaigns.GetSentCampaigns.

Campaigns.GetCampaignInteractions.

OVERVIEW

This document outlines the functions and operations available via the Zulu eDM API.

The API provides access to some of the data and features of your Zulu eDM account via a SOAP based platform. Whilst not all platform data is made available via the API, it is hoped that the available functions will provide some meaningful data endpoints for integrating into your own custom applications.

If there is something within the eDM platform you specifically need access too that isn’t specified within the API documentation, please feel free to contact us to see if we can cater for this through either further API development or a custom integrated solution.

*Note: The Zulu eDM API is only available on certain versions of the software. Please contact us if you require access to the API to discuss your requirements further.

 API ACCESS

The API is accessed via SOAP calls made to various function endpoints (as specified further down in the document). All requests made to the API must include an account API Key as well as valid eDM Username and Password credentials belonging to the account you are trying to access.

Common Request Parameters

API KEY

Each eDM account is assigned an individual and unique API Key which identifies which eDM account to access and execute the functions on at the time of receiving the request.

LOGIN CREDENTIALS

Login credentials must be provided in each API request and are the same as those used to login to the web application as normal via your web browser.

API REQUEST PARAMETER ORDER

Please note that for API versions 1.0 (https://api.au.zuluedm.com/api/?wsdl) and 1.1 (https://api.au.zuluedm.com/api/1.1/?wsdl) all parameters listed in this document must be specified in the order as they appear.

GENERIC ERROR RESPONSE CODES

API methods will respond with a designated code dependent on the result of the action requested. There are several “Generic” response codes that can be returned regardless of which API method is called. The details of these response codes are listed below:

CONTACT OPERATIONS

Listed below are the methods available to interact with the contacts section of the platform.

Contacts.AddContact

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to add and edit contacts within the system. (*Note: If an email address that exists is provided in the request, the existing contact record is updated)

*Please note: All parameters specified below in the request parameter table must be built in an associative array format as displayed below and the $data value passed as the first parameter to the API function. E.g.

$data[] = array('field'    => 'firstname', 'value' => 'Jason')
$data[] = array('field'    => 'lastname', 'value' => 'Mc\'Allindon');
$data[] = array('field'    => 'country', 'value' => 'Sudan');
$data[] = array('field'    => 'email', 'value' => 'testemail@testemail.org')

/* Add the Contact to the System */

$result = $client->__soapCall('Contacts.AddContact', array(

    'apikey' => $apiKey,

    'user' => $username,

    'pass' => $password,

    'data' => $data

));

Request Parameters

Fault Codes

Sample Code

<?php

/* API Credentials */

$apiURL = 'https://api.au.zuluedm.com/api/1.1/?wsdl';

$apiKey = 'apikey';

$username = 'username';

$password = 'password';

/* Create a SOAP Client Object */

$client = new SoapClient($apiURL, array('trace' => 1, 'cache_wsdl' => WSDL_CACHE_NONE));

/* Setup the Contact Array of Details */

$data[] = array('field'    => 'firstname', 'value' => 'First Name');

$data[] = array('field'    => 'lastname', 'value' => 'Last Name');

$data[] = array('field'    => 'country', 'value' => 'Argentina');

$data[] = array('field'    => 'email', 'value' => 'testemail@emailtest.com');

$data[] = array('field'    => 'telephone', 'value' => '08234723837');

$data[] = array('field'    => 'subscribed', 'value' => '1');

$result = null;

try {

    /* Add the Contact to the System */

    $result = $client->__soapCall('Contacts.AddContact', array(

        'apikey' => $apiKey,

        'user' => $username,

        'pass' => $password,

        'data' => $data

    ));

    if ($result->status === '101') {

         // Contact Successfully Added/Updated

         /* The contactid variable returned is the primary key of the generated or updated user */

         //$result->contactid

    }

    echo '<pre>';

    var_dump($result);

    echo '</pre>';

} catch (SoapFault $soapFault) {

    var_dump($soapFault->faultcode);

}

Sample Response

Contacts.GetContactsByGroup

Endpoint: https://api.au.zuluedm.com/api/?wsdl
Description: This function is used to retrieve contacts within a specified group in the system.
Request Parameters

Fault Codes

GROUP OPERATIONS

Listed below are the methods available to interact with the groups section of the platform.

Groups.AddContactToGroup

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to add a contact to a group.
Request Parameters

Fault Codes

Sample Code

<?php

/* API Credentials */

$apiURL = 'https://api.au.zuluedm.com/api/1.1/?wsdl';

$apiKey = 'apikey';

$username = 'username';

$password = 'password';

/* Create a SOAP Client Object */

$client = new SoapClient($apiURL, array('trace' => 1, 'cache_wsdl' => WSDL_CACHE_NONE));

$result = null;

try {

    /* Add the Contact to the System */

    $result = $client->__soapCall('Groups.AddContactToGroup', array(

        'apikey' => $apiKey,

        'user' => $username,

        'pass' => $password,

        'group_id' => 3,

        'people_id' => 6

    ));

    if ($result->status === '101') {

         // Contact Successfully Added to Group

    }

    echo '<pre>';

    var_dump($result);

    echo '</pre>';

} catch (SoapFault $soapFault) {

    var_dump($soapFault);

}

Sample Response

Groups.RemoveContactFromGroup

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to remove a contact from the specified group.
Request Parameters

Fault Codes

Groups.GetListing

Endpoint: https://api.au.zuluedm.com/api/?wsdl
Description: This function is used to retrieve the list of groups within the system.
Request Parameters

Fault Codes

Groups.EditGroup

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to create or edit a group.
Request Parameters

Fault Codes

CAMPAIGN OPERATIONS

Listed below are the methods available to interact with the campaigns section of the platform.

Campaigns.GetSentCampaigns

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to retrieve the list of sent email campaigns in a given folder.
Request Parameters

Fault Codes

Campaigns.GetCampaignInteractions

Endpoint: https://api.au.zuluedm.com/api/1.1/?wsdl
Description: This function is used to retrieve all interactions of the given type for the campaign specified.
Request Parameters

Fault Codes

Sample Code

Sample Response