Using the Endropper API

The Endropper API gives you deep integration with any number of  third party applications and websites.

Our API is a full-featured REST based system, giving you full access to the API function of almost every functionality that you can see in the Endropper user interface.


Getting Started

Before you can connect to the Endropper API, you will need to Create an API Key, these allow you to use the system without needing to send a username and password each time.

You can create as many keys are you wish, all to be used by different systems - thus being able to revoke access in the future, without needing to update your account password.

Using the API

The API Endpoint accepts requests in either the POST or GET method, returning either a JSON or XML object (set by using the ResponseFormat field) and is found at the following location:

https://endropper.com/api.php

API Example

For this example, we will add a subscriber to a mailing list of ID 9000 using the Subscriber.Subscribe command and the GET method.

Request

https://endropper.com/api.php?apikey=XXXX-XXXX-XXXX&command=subscriber.subscribe&responseformat=XML&listid=9000&emailaddress=example@example.com&ipaddress=x.x.x.x
NOTE: For the Subscriber.Subscribe command, the 'apikey' field is optional - if you are calling this command from the client side (so visible to end users) it should NOT be used.  

Response

Once you execute the above API call, you will receive either success data or error data.

If an error has occured, you can use the "ErrorCode" field to look up the specific error to that function.

On Error

<?xml version="1.0" encoding="utf-8"?>
<response>
   <Success><![CDATA[]]></Success>
   <ErrorCode><![CDATA[4]]></ErrorCode>
</response>

On Success

<?xml version="1.0" encoding="utf-8"?>
<response>
   <Success><![CDATA[1]]></Success>
   <ErrorCode><![CDATA[0]]></ErrorCode>
   <SubscriberID><![CDATA[1]]></SubscriberID>
   <RedirectURL><![CDATA[]]></RedirectURL>
   <Subscriber>
      <SubscriberID><![CDATA[1]]></SubscriberID>
      <EmailAddress><![CDATA[example@example.com]]></EmailAddress>
      <BounceType><![CDATA[Not Bounced]]></BounceType>
      <SubscriptionStatus><![CDATA[Opt-In Pending]]></SubscriptionStatus>
      <SubscriptionDate><![CDATA[0000-00-00]]></SubscriptionDate>
      <SubscriptionIP><![CDATA[x.x.x.x]]></SubscriptionIP>
      <UnsubscriptionDate><![CDATA[0000-00-00]]></UnsubscriptionDate>
      <UnsubscriptionIP><![CDATA[0.0.0.0]]></UnsubscriptionIP>
      <OptInDate><![CDATA[2018-05-16]]></OptInDate>
      <EngagementDate><![CDATA[0000-00-00]]></EngagementDate>
   </Subscriber>
</response>


Command Reference

The full list of available API commands with syntax and error return codes can be found grouped by category in the main Endropper API section.
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Creating an API Key

In order to use the Endropper system you will need to connect with an API key.You can create as...