RuleMailer API v3.0 - Skapa spännande applikationer med RuleMailer

Introduktion

RuleMailer API v3.0

RuleMailer är utrustat med ett kraftfullt API. Utöka din applikation till att även kommunicera med RuleMailer. Det är väldigt enkelt att komma igång.

Här nedan följer en presentation av alla funktioner.

API example module for RuleMailer

Holds all the API functions for RuleMailer API.

All methods return an array, with first two elements being: error_code and status. For example: array( error_code = 0, status = Success ).

The code examples are written in PHP and are called with:

$wsdl = 'http://one.rulemailer.com/api3.3.php?wsdl'; //url to the wsdl
$soapClient = new SOAPClient($wsdl); //setup the soapclient
$key='xxx'; // the key is used in every call to the web service

Functions

campaignCreate

$campaign_name = 'Test Campaign';
$time_to_send = 'Later';
$campaign = $soapClient->campaignCreate($key, $campaign_name, $list_id, $email_id, $time_to_send);

$campaign_id = $campaign->id;

campaignUpdate

$campaign_name = 'Test Campaign';
$time_to_send = 'Later';
$campaign = $soapClient->campaignCreate($key, $campaign_name, $list_id, $email_id, $time_to_send);

$campaign_id = $campaign->id;

campaignStatisticsOverview

$campaign_statistics = $soapClient->campaignStatisticsOverview($key, $SAMPLE_CAMPAIGN_ID);
	
echo $campaign_statistics->campaign_name;
echo $campaign_statistics->send_date;
echo $campaign_statistics->total_sent;
echo $campaign_statistics->total_opens;
echo $campaign_statistics->total_clicks;
echo $campaign_statistics->total_forwards;
echo $campaign_statistics->total_browser_view;
echo $campaign_statistics->total_unsubscriptions;
echo $campaign_statistics->total_hard_bounces;
echo $campaign_statistics->total_soft_bounces;

foreach ($campaign_statistics->open_activities as $open_activity) {
	echo $open_activity->date;
	echo $open_activity->total;
	echo $open_activity->unique;
}
foreach ($campaign_statistics->click_activities as $click_activity) {
	echo $click_activity->date;
	echo $click_activity->total;
	echo $click_activity->unique;
}

campaignStatisticsSubscribers

$campaign_statistics_subscribers = $soapClient->campaignStatisticsSubscribers($key, $SAMPLE_CAMPAIGN_ID);

echo $campaign_statistics_subscribers->campaign_name;
echo $campaign_statistics_subscribers->send_date;

foreach ($campaign_statistics_subscribers->subscribers_activities as $subscriber_activity) {
	echo $subscriber_activity->subscriber_id;
	echo $subscriber_activity->email;
	echo $subscriber_activity->total_opens;
	echo $subscriber_activity->total_clicks;
	echo $subscriber_activity->unsubscribed;
	foreach ($subscriber_activity->activities as $activity) {
		echo $activity->time;
		echo $activity->activity;
	}
}

emailCreate

$from_name = 'John Doe';
$from_email= 'john@example.net';
$email_subject = 'Test subject';
$email_plain_text = "Hi! \n%Link:Unsubscribe%";
$email_html = '&lt;html&gt;&lt;body&gt;Hi!&lt;br&gt;<%Link:Unsubscribe%&lt;/body&gt;&lt;html&gt;';

$email = $soapClient->emailCreate($key, $from_name, $from_email, $email_subject, $email_plain_text, $email_html);

$email_id = $email->id;

emailCreateFromTemplate

$from_name = 'John Doe';
$from_email= 'john@example.net';
$template_id = '123';

$email = $soapClient->emailCreateFromTemplate($key, $from_name, $from_email, $template_id);

$email_id = $email->id;

listCreate

$list_create = $soapClient->listCreate($key, $list_name, $type);

$error_code = $list_create_result->error_code;
$status = $list_create->status;
$list_id = $list_create->id;

listCustomFieldCreate

$custom_field_name = 'First name';
$custom_field_type = 'Single line';
$presets = '';

$custom_field = $soapClient->listCustomFieldUpdate($key, $list_id, $custom_field_id, $custom_field_name, $custom_field_type, $presets);

$custom_field_id = $custom_field->id;
$custom_field_name = $custom_field->name;

listCustomFieldsGet

$custom_fields = $soapClient->listCustomFieldsGet($key, $list_id);

foreach ($custom_fields->custom_fields as $custom_field) {
	echo $custom_field->id;
	echo $custom_field->name;
	echo $custom_field->type;
	foreach ($custom_field->preset as $preset) {
		echo $preset->label;
		echo $preset->value;
	}
}

listCustomFieldUpdate

$custom_field_name = 'First name';
$custom_field_type = 'Single line';
$presets = '';

$custom_field = $soapClient->listCustomFieldUpdate($key, $list_id, $custom_field_id, $custom_field_name, $custom_field_type, $presets);

$custom_field_id = $custom_field->id;
$custom_field_name = $custom_field->name;

listDelete

$list_delete = $soapClient->listDelete($key, $list_id);
	
$error_code = $list_delete->error_code;
$status = $list_delete->status;

listsGet

$lists_get = $soapClient->listsGet($key);

foreach ($lists_get->lists as $lists) {
	echo $lists->id;
	echo $lists->name;
}

subscriberGet

$response = $soapClient->subscriberGet($key, $list_id, $email_address);

echo $response->subscriber_id;
echo $response->email;
echo $response->bounce_type;
echo $response->subscription_status;
echo $response->subscription_date;
echo $response->unsubscription_date;
foreach ($response->custom_fields as $custom_field) {
	echo $custom_field->id;
	echo $custom_field->value;
}

subscribersGet

$response = $soapClient->subscribersGet($key, $SAMPLE_LIST_ID);

foreach ($response->subscribers as $subscriber) {
	echo $subscriber->subscriber_id;
	echo $subscriber->email;
	echo $subscriber->subscription_status;
	echo $subscriber->bounce_type;
	echo $subscriber->subscription_date;
	echo $subscriber->unsubscription_date;
	foreach ($subscriber->custom_fields as $custom_field) {
		echo $custom_field->id;
		echo $custom_field->value;
	}
}

subscribersSubscribe

$SAMPLE_EMAIL_ADDRESSES = "'test@example.net';'John'\n'test@example.org';'Albert'"; //Rembember one subscriber on each row //Rembember one subscriber on each row
$field_terminator = ";"; // corresponds to settings for csv-file, if not used, set to ''.
$field_enclosed = "'"; // corresponds to settings for csv-file, if not used, set to ''.
$field_mapping = array(array('column_id' => '2', 'custom_field_id' => '1'));

$response = $soapClient->subscribersSubscribe($key, $SAMPLE_LIST_ID, $field_terminator, $field_enclosed, $field_mapping, $SAMPLE_EMAIL_ADDRESSES);

$total_subscribed = $response->total_subscribed;

subscriberSubscribe

$SAMPLE_LIST_ID = '1';
$SAMPLE_EMAIL_ADDRESS = 'test@example.com';
$SAMPLE_CUSTOM_FIELDS = array(array('id'=>'1', 'value' => 'John'), array('id'=>'2', 'value' => 'Doe'));

$response = $soapClient->subscriberSubscribe($key, $SAMPLE_LIST_ID, $SAMPLE_EMAIL_ADDRESS, $SAMPLE_CUSTOM_FIELDS);

$error_code = $response->error_code; //all calls resturns this
$status = $response->status; //all calls resturns this

subscriberUnsubscribe

$response = $soapClient->subscriberUnsubscribe($key, $SAMPLE_LIST_ID, $SAMPLE_EMAIL_ADDRESS);

$error_code = $response->error_code; //all calls resturns this
$status = $response->status; //all calls resturns this

subscriberUpdate

$response = $soapClient->subscriberUpdate($key, $SAMPLE_LIST_ID, $SAMPLE_EMAIL_ADDRESS, $SAMPLE_CUSTOM_FIELDS);
$error_code = $response->error_code; //all calls resturns this
$status = $response->status; //all calls resturns this