SENSORPRO API Guide

API Endpoints

Calling the API

Use HTTP GET/POST in any language of your preference. C#, Node.js, Python, JSON and Ajax examples below.

Sensorpro API Endpoint

https://newsletter.ie/run/APTE.aspx

Sensorpro on-premise API Endpoint

https://(your domain)/sensorpro/run/APTE.aspx

Authentication

All API's require that you authenticate with every request. Your API key is automatically generated in your Trigger campaign and would look like this:

https://newsletter.ie/run/APTE.aspx?apikey=71c80d74-c94c-48d9-9c02-3a44d0e6232f

Sample Code JSON:

$.getJSON('https://newsletter.ie/run/APTE.aspx?apikey=71c80d74-c94c-48d9-9c02-3a44d0e6232f&camp=89c2a66e-b8b6-42cc-846f-6fdad6b9dcc4&bcast=1&email={emailaddress}&delay=0', function(data)
{
});

Sample Code AJAX:

$.ajax({
type: 'POST',    
url:'http://https://newsletter.ie/run/APTE.aspx',
data:{
'apikey': apikey,
'camp': camp,
'bract': bract,
'email': email,
'delay': delay
},
success: function(){
}
});

Sample Code Node.js

require('http')
http.get('https://newsletter.ie/run/APTE.aspx', function(res) {
  console.log(res)
})
{
'apikey': apikey,
'camp': camp,
'bract': bract,
'email': email,
'delay': delay
}

Sample Code C#

HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://newsletter.ie/run/APTE.aspx?apikey={APIKEY}&camp={TriggeredCampaignId}&bcast={BroadCastId}&email={email}&delay=0");
            response.ExecutedURL = strURL.Trim();
            request.Timeout = 10000;
            request.Method = "GET";
            using (System.IO.StreamWriter streamWriter = new System.IO.StreamWriter(request.GetRequestStream()))
            {
                streamWriter.Write("");
                streamWriter.Flush();
                streamWriter.Close();
            }
            response.WebResponse = (HttpWebResponse)request.GetResponse();
            if (response.WebResponse != null)
            {
                using (System.IO.StreamReader streamReader = new System.IO.StreamReader(response.WebResponse.GetResponseStream()))
                {
                    string result = streamReader.ReadToEnd();
                    response.Result = result;
                }
            }

Sample Code Python

import urllib

url = 'https://newsletter.ie/run/APTE.aspx'

params = urllib.urlencode({
'apikey': apikey,
'camp': camp,
'bract': bract,
'email': email,
'delay': delay
})

data = urllib.urlopen(url, params).read()

Substitution Data

&ApiKey API key System will default
&Camp Campaign id will be defaulted by the system
&BCact Broadcast id will be defaulted by the system

Required Parameters:

&Email: The email address which will be added to the subscriber database & emailed
&Delay: Delay the email by x minutes

Optional Parameters:

The following parameters can be passed as part of the contact record

FirstName	DateofBirth	OptOut	Date4
InFix	DateOfLastPurchase	PerState	Date5
LastName	GroupBy1	PerZip	UserChar10
PersonalEMail	GroupBy2	PerCountry	UserChar11
Gender	GroupBy3	JobTitle	UserChar12
PhoneBusiness	GroupByIndustry	PerStreet	UserChar13
BusName	HomeFax	PerStreet1	UserChar14
BusStreet	Num1	PerCity	UserChar15
BusStreet1	Num2	Category	UserChar2
BusCity	Num3	BusinessEmail	UserChar3
BusState	Num4	BusinessEmail1	UserChar4
BusZip	Num5	BusinessFax	UserChar5
BusCountry	Pager	BusWebSite	UserChar6
MessagePreference	Password	Date1	UserChar7
PhoneHome	PersonalEmail1	Date2	UserChar8
PhoneMobile	PhoneOther	Date3	UserChar9

Custom Data:

You may wish to pass data that is not part of the Sensorpro database i.e. from your own app. This data can be referenced to merge the data into the outgoing email. This data must be passed as encoded XML. Example:

<cdata> 
<r  name=”Item” value=”Bling Shoes” /> 
<r  name=”Cost” value=”20.30” /> 
<r  name=”OrderId” value=”0212020” /> 
</cdata>

These values can be referenced in the email design using the name value:
{item}
{Cost}
{OrderId}

API Status

To check the API call status: Admin/Setup/RequestQueueStatus
This is will list all of the queued calls and whether they have completed or not.

Get started

1 Create a Trigger campaign type

2 Select one of the templates provided or insert your own.

3 Note the API key and other parameters from the Broadcast screen

4 Verify your code and start sending.

Get Help.

We love Developers: Get help directly from our Engineering team.

Create your developer account:

Create Account