emailplatform/api_parser

PHP class for using our company's API as part of the subscription

ApiParser

PHP class for using our company's API as part of the subscription., _(*1)

, _(*2)

Installation

Run following command in terminal from the root of your project:, _(*3)

composer require emailplatform/api_parser

You can load dependencies by adding these lines to your code:, _(*4)

require_once 'vendor/emailplatform/api_parser/src/settings.php';
require_once 'vendor/emailplatform/api_parser/src/ApiParser.class.php';

, _(*5)

How to use

1. Set up your API credentials (apiusername & apitoken) into settings.php
2. Create instance from ApiParser.class.php

$parser = new ApiParser($settings);

1. Call method from ApiParser

$subscriberid = 68317547;
$listid = 0;
$emailaddress = "";
$mobileNumenr = "";
$mobilePrefix = "";
$fieldid = 14;
$fieldValue = array(
   'Lastname' => "Tom",
   'Firstname' => 'Jones',
   'Date' => '31-12-2020 T00:00',
   'Active' => 0
);
$path = 'Users[Lastname=SimpleChange4]';

$result = $parser->UpdateOTMDocument($subscriberid, $listid, $emailaddress, $mobileNumber, $mobilePrefix, $fieldid, $fieldValue, $path);

print_r($result);

, _(*6)

Changelog:

Differences between v1.2.21 and v1.2.22

Method definition changed:

• ChangeMobile > Now: > php > $Mobile no longer require parameters >

Differences between v1.2.19 and v1.2.21

Method definition changed:

• ScheduleSendSMS > *Previous:

public function ScheduleSendSMS($campaignid = false, $lists = false, $hours = false)
  

Now:, _(*7)

public function ScheduleSendSMS($campaignid = false, $hours = false)
  

Differences between v1.2.16 and v1.2.17

Method definition changed:

• UpdateOTMDocument > Previous:

public function UpdateOTMDocument ($subscriberid = 0, $fieldid = 0, $fieldValueOTM = array(), $path = "")
  

Now:, _(*8)

public function UpdateOTMDocument ($subscriberid = 0, $listid = 0, $emailaddress = "", $mobileNumber = "", $mobilePrefix = "", $fieldid = 0, $fieldValueOTM = array(), $path = "")
  

• Added: listid, emailaddress, mobileNumber and mobilePrefix.
  

Differences between v1.2.15 and v1.2.16

Method definition changed:

• GetSubscriberDetails > Previous: listid was required.

Now: listid is not required if subscriberid is specified., _(*9)

Differences between v1.2.14 and v1.2.15

Method definition changed:

• ScheduleSendNewsletter > Previous:

public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true)
  

Now:, _(*10)

public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
  

• Added: notifyOwner
  

• ScheduleSendNewsletterToLists, _(*11)

  Previous:, _(*12)

  public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true)
    

  Now:, _(*13)

  public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
    

  • Added: notifyOwner
    

• ScheduleSendNewsletterToSegments, _(*14)

  Previous:, _(*15)

  public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true)
    

  Now:, _(*16)

  public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true, $notifyOwner = false)
    

  • Added: notifyOwner
    

• SendNewsletter, _(*17)

  Previous:, _(*18)

  public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false)
    

  Now:, _(*19)

  public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false, $notifyOwner = false)
    

  • Added: notifyOwner
    

New method:

• UpdateOTMDocument, _(*20)

  public function UpdateOTMDocument ($subscriberid = 0, $fieldid = 0, $fieldValueOTM = array(), $path = "")
    

  
  , _(*21)

• RemoveOTMDocument, _(*22)

  public function RemoveOTMDocument ($subscriberid = 0, $fieldid = 0, $path = "", $index = 0)
    

  
  , _(*23)

Differences between v1.2.13 and v1.2.14

Method definition changed:

• ScheduleSendNewsletter, _(*24)

  Previous:, _(*25)

  public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true)
    

  Now:, _(*26)

  public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true, $reloadFeed = true)
    

  • Added: reloadFeed
    

• ScheduleSendNewsletterToLists, _(*27)

  Previous:, _(*28)

  public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array())
    

  Now:, _(*29)

  public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array(), $saveSnapshots = true, $reloadFeed = true)
    

  • Added: saveSnapshots and reloadFeed
    

• ScheduleSendNewsletterToSegments, _(*30)

  Previous:, _(*31)

  public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array())
    

  Now:, _(*32)

  public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array(), $saveSnapshots = true, $reloadFeed = true)
    

  • Added: saveSnapshots and reloadFeed
    

Differences between v1.2.12 and v1.2.13

New method:

• CreateSegment > php > public function CreateSegment($name = "", $rules = array(), $connector = 'and') >
  

Differences between v1.2.11 and v1.2.12

New method:

• AddCustomFieldsToList > php > public function AddCustomFieldsToList($listid = false, $customFields = array()) >
  

Differences between v1.2.10 and v1.2.11

Method definition changed:

• SendNewsletter > Previous: > php > public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '') > > Now: > php >public function SendNewsletter($newsletterid = 0, $subscriberid = 0, $email = '', $senderEmail = '', $senderName = '', $replyEmail = '', $callbackUrl = false, $reloadFeed = false) > > * Added: callbackUrl and reloadFeed
  

Differences between v1.2.9 and v1.2.10

New methods:

• ScheduleSendNewsletterToLists, _(*33)

  Definition:, _(*34)

  public function ScheduleSendNewsletterToLists($newsletterid = false, $timeToSend = false, $listids = array())
    

  
  , _(*35)

• ScheduleSendNewsletterToSegments, _(*36)

  Definition:, _(*37)

  public function ScheduleSendNewsletterToSegments($newsletterid = false, $timeToSend = false, $segmentids = array()))
    

  
  , _(*38)

Differences between v1.2.7 and v1.2.9

Method definition changed:

• ScheduleSendNewsletter > Previous: > php > public function ScheduleSendNewsletter($campaignid = false, $hours = false) > > Now: > php > public function ScheduleSendNewsletter($campaignid = false, $hours = false, $saveSnapshots = true) > > * Added: $saveSnapshots
  

New methods:

• GetSentEmailCampaignEvents, _(*39)

  Definition:, _(*40)

  public function GetSentEmailCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*41)

• GetSentEmailCampaignWithTriggerEvents, _(*42)

  Definition:, _(*43)

  public function GetSentEmailCampaignWithTriggerEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*44)

• GetOpenCampaignEvents, _(*45)

  Definition:, _(*46)

  public function GetOpenCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*47)

• GetOpenTriggersEvents, _(*48)

  Definition:, _(*49)

  public function GetOpenTriggersEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*50)

• GetLinkClickCampaignEvents, _(*51)

  Definition:, _(*52)

  public function GetLinkClickCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*53)

• GetLinkClickTriggerEvents, _(*54)

  Definition:, _(*55)

  public function GetLinkClickTriggerEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*56)

• GetSentAutoresponderEvents, _(*57)

  Definition:, _(*58)

  public function GetSentAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*59)

• GetOpenAutoresponderEvents, _(*60)

  Definition:, _(*61)

  public function GetOpenAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*62)

• GetLinkClickAutoresponderEvents, _(*63)

  Definition:, _(*64)

  public function GetLinkClickAutoresponderEvents($from = false, $to = false $limit = 10, $offset = 0)
    

  
  , _(*65)

• GetSentSMSCampaignEvents, _(*66)

  Definition:, _(*67)

  public function GetSentSMSCampaignEvents($from = false, $to = false $limit = 10, $offset = 0)
    

, _(*68)

Differences between v1.2.6 and v1.2.7

New method:

• GetTrackingEvents > Definition: > php > public function GetTrackingEvents($listid = false, $subscriberid = false, $limit = 100, $offset = 0) >

, _(*69)

Differences between v1.2.5 and v1.2.6

New methods:

• GetLeadScore, _(*70)

  Definition:, _(*71)

  public function GetLeadScore($subscriberid = false)
    

  
  , _(*72)

• SetLeadScore, _(*73)

  Definition:, _(*74)

  public function SetLeadScore($subscriberid = false, $leadScore = false, $type = "add")
    

, _(*75)

Differences between v1.2.4 and v1.2.5

Method condition changed:

• GetCustomFields > Previous: > php > public function GetCustomFields($listids = false) > > Now: > php > public function GetCustomFields($listids = false) > > * listids: is not required.

, _(*76)

Differences between v1.2.3 and v1.2.4

New methods:

• GetSnapshots, _(*77)

  Definition:, _(*78)

  public function GetSnapshots($subscriberid = false, $triggerid = false, $autoresponderid = false, $campaignid = false, $groupby = "date")
    
    

  
  , _(*79)

• GetNewsletterSummary, _(*80)

  Definition:, _(*81)

  public function GetNewsletterSummary($newsletterid = false, $statid = false, $from = false, $to = false)
    
    

  
  , _(*82)

• GetStatids, _(*83)

  Definition:, _(*84)

  public function GetStatids($listid = false, $segmentid = false, $newsletterid = false, $from = false, $to = false, $limit = 100, $offset = 0)
    
    

, _(*85)

Differences between v1.2.2 and v1.2.3

Method definition changed:

• ResubscribeContact > Previous: > php > public function ResubscribeContact($listid = false, $emailaddress = false, $mobileNumber = false, $mobilePrefix = false, $add_to_autoresponders = false) > > Now: > php > public function ResubscribeContact($listid = false, $emailaddress = false, $mobileNumber = false, $mobilePrefix = false, $add_to_autoresponders = false, $contactFields = array()) > > * Added: $contactFields.

, _(*86)

Differences between v1.2.1 and v1.2.2

New methods:

• GetTriggers, _(*87)

  Definition:, _(*88)

  public function GetTriggers($listid = false, $limit = 1000, $offset = 0)
    
    

  br/, _(*89)

• GetSegments, _(*90)

  Definition:, _(*91)

  public function GetSegments($listid = false, $count_subscribers = false, $limit = 100, $offset = 0)
    
    

, _(*92)

Differences between v1.1.11 and v1.2.1

New methods:

• AddToOTMDocument, _(*93)

  Definition:, _(*94)

  public function AddToOTMDocument ($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobilePrefix = false, $fieldid = false, $values = array(), $path = false)
    
    

  
  , _(*95)

• GetSubscribersByCustomField, _(*96)

  Definition:, _(*97)

  public function GetSubscribersByCustomField ($listid = false, $data = array(), $activeonly = true, $countonly = false, $limit = 1000, $offset = 0)
    
    

, _(*98)

Differences between v1.1.10 and v1.1.11

New methods:

• GetTriggerSummary, _(*99)

  Definition:, _(*100)

  public function GetTriggerSummary($triggerid = false, $from = false, $to = false)
    
    

  br/, _(*101)

• GetAutoresponderSummary, _(*102)

  Definition:, _(*103)

  public function GetAutoresponderSummary($autoresponderid = false, $from = false, $to = false)
    
    

  
  , _(*104)

Differences between v1.1.9 and v1.1.10

New methods:

• GetSegmentSummary, _(*105)

  Definition:, _(*106)

  public function GetSegmentSummary($segmentid = false, $from = false, $to = false)
    
    

  
  , _(*107)

• GetRulesForSegment, _(*108)

  Definition:, _(*109)

  public function GetRulesForSegment($segmentid = false)
    
    

  
  , _(*110)

• EditNewsletter, _(*111)

  Definition:, _(*112)

  public function EditNewsletter($newsletterid = false, $name = false, $subject = false)
    
    

  
  , _(*113)

• SetTriggerStatus, _(*114)

  Definition:, _(*115)

  public function SetTriggerStatus($triggerid = false, $status = false)
    
    

  
  , _(*116)

• SetAutoresponderStatus, _(*117)

  Definition:, _(*118)

  public function SetAutoresponderStatus($autoresponderid = false, $status = false)
    
    

, _(*119)

Differences between v1.1 and v1.1.9

New methods:

• SendSMS, _(*120)

  Definition:, _(*121)

  public function SendSMS($campaignid = 0, $subject = '', $text = '', $subscriberid = 0, $listid = 0, $mobile = '', $mobilePrefix = '')
    
    

  
  , _(*122)

• GetSubscribersFromSegment, _(*123)

  Definition:, _(*124)

  public function GetSubscribersFromSegment($segmentid = false, $countonly = false, $activeonly = true, $limit = 100, $offset = 0)
    
    

  
  , _(*125)

• GetTriggersForSegment, _(*126)

  Definition:, _(*127)

  public function GetTriggersForSegment($segmentid)
    
    

  
  , _(*128)

• ViewNewsletter, _(*129)

  Definition:, _(*130)

  public function ViewNewsletter($newsletterid)
    
    

  
  , _(*131)

Method definition changed:

• GetNewsletters > Previous: > php > public function GetNewsletters($countOnly= false, $getLastSentDetails = false, $content = true, $aftercreatedate = false, $newsletterNameLike = false) > > Now: > php > public function GetNewsletters($countOnly= false, $getLastSentDetails = false, $content = true, $aftercreatedate = false, $newsletterNameLike = false, $limit = false, $offset = false) > > * Added: $limit & $offset.

, _(*132)

Differences between v1.0 and v1.1

Renamed methods:

, _(*133)

Method definition changed:

• UnsubscribeSubscriberEmail, _(*134)

  Previous:, _(*135)

  public function UnsubscribeSubscriberEmail ($emailaddress = false, $listid = false, $subscriberid = false, $skipcheck = false, $statid = false)
    

  Now:, _(*136)

  public function UnsubscribeSubscriberEmail ($listid = false, $emailaddress = false, $subscriberid = false, $skipcheck = false, $statid = false)
    

  
  , _(*137)

• UnsubscribeSubscriberMobile, _(*138)

  Previous:, _(*139)

  public function UnsubscribeSubscriberMobile ($mobile = false, $mobilePrefix = false, $listid = false, $subscriberid = false, $skipcheck = false, $statid = false)
    

  Now:, _(*140)

  public function UnsubscribeSubscriberMobile ($listid = false, $mobile = false, $mobilePrefix = false, $subscriberid = false, $skipcheck = false, $statid = false)
    
    

  
  , _(*141)

• GetSubscriberDetails, _(*142)

  Previous:, _(*143)

  public function GetSubscriberDetails($emailaddress = false, $listid = false)
    
    

  Now:, _(*144)

  public function GetSubscriberDetails($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobile_prefix = false)
    
    

  • Added: subscriberid, mobile and mobile_prefix.
    

• GetRecipients, _(*145)

  Previous:, _(*146)

  public function GetRecipients($statid = false, $stats_type = false, $count_only = false)
    
    

  Now:, _(*147)

  public function GetRecipients($statid = false, $count_only = false)
    
    

  • Removed: stats_type.
    

• ActivateSubscriber, _(*148)

  Previous:, _(*149)

  public function ActivateSubscriber ($service = false, $lists = false, $emailaddress = false, $mobile = false, $mobile_prefix = false)
    
    

  Now:, _(*150)

  public function ActivateSubscriber ($service = false, $listid = false, $emailaddress = false, $mobile = false, $mobile_prefix = false, $subscriberid = false)
    
    

  • Added: subscriberid.
    

• UpdateSubscriber, _(*151)

  Previous:, _(*152)

  public function UpdateSubscriber($subscriberid = false, $emailaddress = false, $mobile = false, $listid = false, $customfields = array())
    
    

  Now:, _(*153)

  public function UpdateSubscriber($listid = false, $subscriberid = false, $emailaddress = false, $mobile = false, $mobilePrefix = false, $customfields = array())
    
    

  • Added: mobile, mobilePrefix.
    

• ScheduleSendSMS, _(*154)

  Previous:, _(*155)

  public function ScheduleSendSMS($campaignid = false, $hours = false, $lists = false)
    
    

  Now:, _(*156)

  public function ScheduleSendSMS($campaignid = false, $lists = false, $hours = false)