Drip_API.class.php
19.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
<?php
/**
* Drip API
* @author Svetoslav Marinov (SLAVI)
*/
Class Drip_Api {
private $version = "2";
private $api_token = '';
private $error_code = '';
private $error_message = '';
private $user_agent = "Drip API PHP Wrapper (getdrip.com)";
private $api_end_point = 'https://api.getdrip.com/v2/';
//private $api_end_point = 'http://localhost/echo/'; // dbg only
private $recent_req_info = array(); // holds dbg info from a recent request
private $timeout = 30;
private $connect_timeout = 30;
private $debug = false; // Requests headers and other info to be fetched from the request. Command-line windows will show info in STDERR
const GET = 1;
const POST = 2;
const DELETE = 3;
const PUT = 4;
/**
* Accepts the token and saves it internally.
*
* @param string $api_token e.g. qsor48ughrjufyu2dadraasfa1212424
* @throws Exception
*/
public function __construct($api_token) {
$api_token = trim($api_token);
if (empty($api_token) || !preg_match('#^[\w-]+$#si', $api_token)) {
throw new Exception("Missing or invalid Drip API token.");
}
$this->api_token = $api_token;
}
/**
* Requests the campaigns for the given account.
* @param array
* @return array
*/
public function get_campaigns($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (isset($params['status'])) {
if (!in_array($params['status'], array('active', 'draft', 'paused', 'all'))) {
throw new Exception("Invalid campaign status.");
}
} elseif (0) {
$params['status'] = 'active'; // api defaults to all but we want active ones
}
$url = $this->api_end_point . "$account_id/campaigns";
$res = $this->make_request($url, $params);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
// here we distinguish errors from no campaigns.
// when there's no json that's an error
$campaigns = empty($raw_json)
? false
: empty($raw_json['campaigns'])
? array()
: $raw_json['campaigns'];
return $campaigns;
}
/**
* Fetch a campaign for the given account based on it's ID.
* @param array (account_id, campaign_id)
* @return array
*/
public function fetch_campaign($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (!empty($params['campaign_id'])) {
$campaign_id = $params['campaign_id'];
unset($params['campaign_id']); // clear it from the params
} else {
throw new Exception("Campaign ID was not specified. You must specify a Campaign ID");
}
$url = $this->api_end_point . "$account_id/campaigns/$campaign_id";
$res = $this->make_request($url, $params);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
// here we distinguish errors from no campaign
// when there's no json that's an error
$campaigns = empty($raw_json)
? false
: empty($raw_json['campaigns'])
? array()
: $raw_json['campaigns'];
return $campaigns;
}
/**
* Requests the accounts for the given account.
* Parses the response JSON and returns an array which contains: id, name, created_at etc
* @param void
* @return bool/array
*/
public function get_accounts() {
$url = $this->api_end_point . 'accounts';
$res = $this->make_request($url);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['accounts'])
? array()
: $raw_json['accounts'];
return $data;
}
/**
* Get a specific account provided by the user
* Parses the response JSON and returns an array which contains: id, name, created_at etc
* @param integer $account_id
* @return bool/array
*/
public function fetch_account($account_id) {
if (empty($account_id)) {
throw new Exception("Account ID not specified");
}
$url = $this->api_end_point . "accounts/{$account_id}";
$res = $this->make_request($url);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['accounts'])
? array()
: $raw_json['accounts'];
return $data;
}
/**
* Sends a request to add a subscriber and returns its record or false
*
* @param array $params
* @param array/bool $account
*/
public function create_or_update_subscriber($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
$api_action = "/$account_id/subscribers";
$url = $this->api_end_point . $api_action;
// The API wants the params to be JSON encoded
$req_params = array('subscribers' => array($params));
$res = $this->make_request($url, $req_params, self::POST);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['subscribers'])
? array()
: $raw_json['subscribers'][0];
return $data;
}
/**
*
* @param array $params
* @param array $params
*/
public function fetch_subscriber($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (!empty($params['subscriber_id'])) {
$subscriber_id = $params['subscriber_id'];
unset($params['subscriber_id']); // clear it from the params
} elseif (!empty($params['email'])) {
$subscriber_id = $params['email'];
unset($params['email']); // clear it from the params
} else {
throw new Exception("Subscriber ID or Email was not specified. You must specify either Subscriber ID or Email.");
}
$subscriber_id = urlencode($subscriber_id);
$api_action = "$account_id/subscribers/$subscriber_id";
$url = $this->api_end_point . $api_action;
$res = $this->make_request($url);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['subscribers'])
? array()
: $raw_json['subscribers'][0];
return $data;
}
/**
* Subscribes a user to a given campaign for a given account.
*
* @param array $params
* @param array $accounts
*/
public function subscribe_subscriber($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (empty($params['campaign_id'])) {
throw new Exception("Campaign ID not specified");
}
$campaign_id = $params['campaign_id'];
unset($params['campaign_id']); // clear it from the params
if (empty($params['email'])) {
throw new Exception("Email not specified");
}
if (!isset($params['double_optin'])) {
$params['double_optin'] = true;
}
$api_action = "$account_id/campaigns/$campaign_id/subscribers";
$url = $this->api_end_point . $api_action;
// The API wants the params to be JSON encoded
$req_params = array('subscribers' => array($params));
$res = $this->make_request($url, $req_params, self::POST);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['subscribers'])
? array()
: $raw_json['subscribers'][0];
return $data;
}
/**
*
* Some keys are removed from the params so they don't get send with the other data to Drip.
*
* @param array $params
* @param array $params
*/
public function unsubscribe_subscriber($params) {
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (!empty($params['subscriber_id'])) {
$subscriber_id = $params['subscriber_id'];
unset($params['subscriber_id']); // clear it from the params
} elseif (!empty($params['email'])) {
$subscriber_id = $params['email'];
unset($params['email']); // clear it from the params
} else {
throw new Exception("Subscriber ID or Email was not specified. You must specify either Subscriber ID or Email.");
}
$subscriber_id = urlencode($subscriber_id);
$api_action = "$account_id/subscribers/$subscriber_id/unsubscribe";
$url = $this->api_end_point . $api_action;
$req_params = $params;
$res = $this->make_request($url, $req_params, self::POST);
if (!empty($res['buffer'])) {
$raw_json = json_decode($res['buffer'], true);
}
$data = empty($raw_json)
? false
: empty($raw_json['subscribers'])
? array()
: $raw_json['subscribers'][0];
return $data;
}
/**
*
* This calls POST /:account_id/tags to add the tag. It just returns some status code no content
*
* @param array $params
* @param bool $status
*/
public function tag_subscriber($params) {
$status = false;
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (empty($params['email'])) {
throw new Exception("Email was not specified");
}
if (empty($params['tag'])) {
throw new Exception("Tag was not specified");
}
$api_action = "$account_id/tags";
$url = $this->api_end_point . $api_action;
// The API wants the params to be JSON encoded
$req_params = array('tags' => array($params));
$res = $this->make_request($url, $req_params, self::POST);
if ($res['http_code'] == 201) {
$status = true;
}
return $status;
}
/**
*
* This calls DELETE /:account_id/tags to remove the tags. It just returns some status code no content
*
* @param array $params
* @param bool $status success or failure
*/
public function untag_subscriber($params) {
$status = false;
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
if (empty($params['email'])) {
throw new Exception("Email was not specified");
}
if (empty($params['tag'])) {
throw new Exception("Tag was not specified");
}
$api_action = "$account_id/tags";
$url = $this->api_end_point . $api_action;
// The API wants the params to be JSON encoded
$req_params = array('tags' => array($params));
$res = $this->make_request($url, $req_params, self::DELETE);
if ($res['http_code'] == 204) {
$status = true;
}
return $status;
}
/**
*
* Posts an event specified by the user.
*
* @param array $params
* @param bool
*/
public function record_event($params) {
$status = false;
if (empty($params['account_id'])) {
throw new Exception("Account ID not specified");
}
if (empty($params['action'])) {
throw new Exception("Action was not specified");
}
$account_id = $params['account_id'];
unset($params['account_id']); // clear it from the params
$api_action = "$account_id/events";
$url = $this->api_end_point . $api_action;
// The API wants the params to be JSON encoded
$req_params = array('events' => array($params));
$res = $this->make_request($url, $req_params, self::POST);
if ($res['http_code'] == 204) {
$status = true;
}
return $status;
}
/**
*
* @param string $url
* @param array $params
* @param int $req_method
* @return type
* @throws Exception
*/
public function make_request($url, $params = array(), $req_method = self::GET) {
if (!function_exists('curl_init')) {
throw new Exception("Cannot find cURL php extension or it's not loaded.");
}
$ch = curl_init();
if ($this->debug) {
//curl_setopt($ch, CURLOPT_HEADER, true);
// TRUE to output verbose information. Writes output to STDERR, or the file specified using CURLOPT_STDERR.
curl_setopt($ch, CURLOPT_VERBOSE, true);
}
curl_setopt($ch, CURLOPT_FRESH_CONNECT, true);
curl_setopt($ch, CURLOPT_FORBID_REUSE, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->connect_timeout);
curl_setopt($ch, CURLOPT_USERPWD, $this->api_token . ":" . ''); // no pwd
curl_setopt($ch, CURLOPT_USERAGENT, empty($params['user_agent']) ? $this->user_agent : $params['user_agent']);
if ($req_method == self::POST) { // We want post but no params to supply. Probably we have a nice link structure which includes all the info.
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
} elseif ($req_method == self::DELETE) {
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
} elseif ($req_method == self::PUT) {
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
}
if (!empty($params)) {
if ((isset($params['__req']) && strtolower($params['__req']) == 'get')
|| $req_method == self::GET) {
unset($params['__req']);
$url .= '?' . http_build_query($params);
} elseif ($req_method == self::POST || $req_method == self::DELETE) {
$params_str = is_array($params) ? json_encode($params) : $params;
curl_setopt($ch, CURLOPT_POSTFIELDS, $params_str);
}
}
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
'Accept:application/json, text/javascript, */*; q=0.01',
'Content-Type: application/vnd.api+json',
));
$buffer = curl_exec($ch);
$status = !empty($buffer);
$data = array(
'url' => $url,
'params' => $params,
'status' => $status,
'error' => empty($buffer) ? curl_error($ch) : '',
'error_no' => empty($buffer) ? curl_errno($ch) : '',
'http_code' => curl_getinfo($ch, CURLINFO_HTTP_CODE),
'debug' => $this->debug ? curl_getinfo($ch) : '',
);
curl_close($ch);
// remove some weird headers HTTP/1.1 100 Continue or HTTP/1.1 200 OK
$buffer = preg_replace('#HTTP/[\d.]+\s+\d+\s+\w+[\r\n]+#si', '', $buffer);
$buffer = trim($buffer);
$data['buffer'] = $buffer;
$this->_parse_error($data);
$this->recent_req_info = $data;
return $data;
}
/**
* This returns the RAW data from the each request that has been sent (if any).
* @return arraay of arrays
*/
public function get_request_info() {
return $this->recent_req_info;
}
/**
* Retruns whatever was accumultaed in error_message
* @param string
*/
public function get_error_message() {
return $this->error_message;
}
/**
* Retruns whatever was accumultaed in error_code
* @return string
*/
public function get_error_code() {
return $this->error_code;
}
/**
* Some keys are removed from the params so they don't get send with the other data to Drip.
*
* @param array $params
* @param array
*/
public function _parse_error($res) {
if (empty($res['http_code']) || $res['http_code'] >= 200 && $res['http_code'] <= 299) {
return true;
}
if (empty($res['buffer'])) {
$this->error_message = "Response from the server.";
$this->error_code = $res['http_code'];
} elseif (!empty($res['buffer'])) {
$json_arr = json_decode($res['buffer'], true);
// The JSON error response looks like this.
/*
{
"errors": [{
"code": "authorization_error",
"message": "You are not authorized to access this resource"
}]
}
*/
if (!empty($json_arr['errors'])) { // JSON
$messages = $error_codes = array();
foreach ($json_arr['errors'] as $rec) {
$messages[] = $rec['message'];
$error_codes[] = $rec['code'];
}
$this->error_code = join(", ", $error_codes);
$this->error_message = join("\n", $messages);
} else { // There's no JSON in the reply so we'll extract the message from the HTML page by removing the HTML.
$msg = $res['buffer'];
$msg = preg_replace('#.*?<body[^>]*>#si', '', $msg);
$msg = preg_replace('#</body[^>]*>.*#si', '', $msg);
$msg = strip_tags($msg);
$msg = preg_replace('#[\r\n]#si', '', $msg);
$msg = preg_replace('#\s+#si', ' ', $msg);
$msg = trim($msg);
$msg = substr($msg, 0, 256);
$this->error_code = $res['http_code'];
$this->error_message = $msg;
}
} elseif ($res['http_code'] >= 400 || $res['http_code'] <= 499) {
$this->error_message = "Not authorized.";
$this->error_code = $res['http_code'];
} elseif ($res['http_code'] >= 500 || $res['http_code'] <= 599) {
$this->error_message = "Internal Server Error.";
$this->error_code = $res['http_code'];
}
}
// tmp
public function __call($method, $args) {
return array();
}
}