|
1
|
|
|
<?php |
|
|
|
|
|
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
|
|
|
|
|
6
|
|
|
* This file is part of the AuthnetJSON package. |
|
7
|
|
|
* |
|
8
|
|
|
* (c) John Conde <[email protected]> |
|
9
|
|
|
* |
|
10
|
|
|
* For the full copyright and license information, please view the LICENSE |
|
11
|
|
|
* file that was distributed with this source code. |
|
12
|
|
|
*/ |
|
13
|
|
|
|
|
14
|
|
|
namespace Authnetjson; |
|
15
|
|
|
|
|
16
|
|
|
use Authnetjson\Exception\AuthnetCurlException; |
|
17
|
|
|
use Authnetjson\Exception\AuthnetInvalidJsonException; |
|
18
|
|
|
use Curl\Curl; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* Creates a request to the Authorize.Net Webhooks endpoints |
|
22
|
|
|
* |
|
23
|
|
|
* @package AuthnetJSON |
|
24
|
|
|
* @author John Conde <[email protected]> |
|
25
|
|
|
* @copyright John Conde <[email protected]> |
|
26
|
|
|
* @license http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0 |
|
27
|
|
|
* @link https://github.com/stymiee/authnetjson |
|
28
|
|
|
* @see https://developer.authorize.net/api/reference/features/webhooks.html |
|
29
|
|
|
*/ |
|
30
|
|
|
class AuthnetWebhooksRequest |
|
31
|
|
|
{ |
|
|
|
|
|
|
32
|
|
|
/** |
|
|
|
|
|
|
33
|
|
|
* @var string Base URL for processing a webhook |
|
34
|
|
|
*/ |
|
35
|
|
|
private $url; |
|
|
|
|
|
|
36
|
|
|
|
|
37
|
|
|
/** |
|
|
|
|
|
|
38
|
|
|
* @var string Endpoint for processing a webhook |
|
39
|
|
|
*/ |
|
40
|
|
|
private $endpoint; |
|
|
|
|
|
|
41
|
|
|
|
|
42
|
|
|
/** |
|
|
|
|
|
|
43
|
|
|
* @var string JSON formatted API request |
|
44
|
|
|
*/ |
|
45
|
|
|
private $requestJson; |
|
|
|
|
|
|
46
|
|
|
|
|
47
|
|
|
/** |
|
|
|
|
|
|
48
|
|
|
* @var object Wrapper object representing an endpoint |
|
49
|
|
|
*/ |
|
50
|
|
|
private $processor; |
|
|
|
|
|
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Creates the request object by setting the Authorize.Net credentials and URL of the endpoint to be used |
|
|
|
|
|
|
54
|
|
|
* for the API call |
|
55
|
|
|
* |
|
56
|
|
|
* @param string $api_url URL endpoint for processing a transaction |
|
|
|
|
|
|
57
|
|
|
*/ |
|
58
|
1 |
|
public function __construct(string $api_url) |
|
|
|
|
|
|
59
|
|
|
{ |
|
|
|
|
|
|
60
|
1 |
|
$this->url = $api_url; |
|
|
|
|
|
|
61
|
1 |
|
} |
|
|
|
|
|
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* Outputs the account credentials, endpoint URL, and request JSON in a human readable format |
|
65
|
|
|
* |
|
66
|
|
|
* @return string HTML table containing debugging information |
|
67
|
|
|
*/ |
|
68
|
2 |
|
public function __toString(): string |
|
69
|
|
|
{ |
|
|
|
|
|
|
70
|
2 |
|
$output = '<table id="authnet-request">'."\n"; |
|
|
|
|
|
|
71
|
2 |
|
$output .= '<caption>Authorize.Net Request</caption>'."\n"; |
|
|
|
|
|
|
72
|
2 |
|
$output .= '<tr><th colspan="2"><b>Class Parameters</b></th></tr>'."\n"; |
|
|
|
|
|
|
73
|
2 |
|
$output .= '<tr><td><b>Authnet Server URL</b></td><td>'.$this->url.'</td></tr>'."\n"; |
|
|
|
|
|
|
74
|
2 |
|
$output .= '<tr><th colspan="2"><b>Request JSON</b></th></tr>'."\n"; |
|
|
|
|
|
|
75
|
2 |
|
if (!empty($this->requestJson)) { |
|
|
|
|
|
|
76
|
1 |
|
$output .= '<tr><td colspan="2"><pre>'."\n"; |
|
|
|
|
|
|
77
|
1 |
|
$output .= $this->requestJson."\n"; |
|
|
|
|
|
|
78
|
1 |
|
$output .= '</pre></td></tr>'."\n"; |
|
|
|
|
|
|
79
|
|
|
} else { |
|
80
|
1 |
|
$output .= '<tr><td colspan="2" style="text-align: center;"><pre>N/A</pre></td></tr>'."\n"; |
|
|
|
|
|
|
81
|
|
|
} |
|
|
|
|
|
|
82
|
2 |
|
$output .= '</table>'; |
|
83
|
|
|
|
|
84
|
2 |
|
return $output; |
|
85
|
|
|
} |
|
|
|
|
|
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* Creates a new webhook |
|
89
|
|
|
* |
|
90
|
|
|
* @param array $webhooks Array of webhooks to be created or modified |
|
|
|
|
|
|
91
|
|
|
* @param string $webhookUrl URL of where webhook notifications will be sent |
|
|
|
|
|
|
92
|
|
|
* @param string $status Status of webhooks to be created or modified [active/inactive] |
|
|
|
|
|
|
93
|
|
|
* @return AuthnetWebhooksResponse |
|
|
|
|
|
|
94
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
95
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
96
|
|
|
*/ |
|
97
|
1 |
|
public function createWebhooks(array $webhooks, string $webhookUrl, string $status = 'active'): object |
|
|
|
|
|
|
98
|
|
|
{ |
|
|
|
|
|
|
99
|
1 |
|
$this->endpoint = 'webhooks'; |
|
|
|
|
|
|
100
|
1 |
|
$this->url = sprintf('%s%s', $this->url, $this->endpoint); |
|
|
|
|
|
|
101
|
|
|
$request = [ |
|
|
|
|
|
|
102
|
1 |
|
'url' => $webhookUrl, |
|
|
|
|
|
|
103
|
1 |
|
'eventTypes' => $webhooks, |
|
|
|
|
|
|
104
|
1 |
|
'status' => $status |
|
|
|
|
|
|
105
|
|
|
]; |
|
|
|
|
|
|
106
|
1 |
|
$this->requestJson = json_encode($request); |
|
107
|
1 |
|
$response = $this->post($this->url, $this->requestJson); |
|
|
|
|
|
|
108
|
1 |
|
return new AuthnetWebhooksResponse($response); |
|
109
|
|
|
} |
|
|
|
|
|
|
110
|
|
|
|
|
111
|
|
|
/** |
|
112
|
|
|
* Sends a test ping to a URL for (a) designated webhook(s) |
|
113
|
|
|
* |
|
114
|
|
|
* @param string $webhookId Webhook ID to be tested |
|
|
|
|
|
|
115
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
116
|
|
|
*/ |
|
|
|
|
|
|
117
|
1 |
|
public function testWebhook(string $webhookId): void |
|
118
|
|
|
{ |
|
|
|
|
|
|
119
|
1 |
|
$this->endpoint = 'webhooks'; |
|
|
|
|
|
|
120
|
1 |
|
$this->url = sprintf('%s%s/%s/pings', $this->url, $this->endpoint, $webhookId); |
|
|
|
|
|
|
121
|
1 |
|
$this->requestJson = json_encode([]); |
|
122
|
1 |
|
$this->post($this->url, $this->requestJson); |
|
123
|
1 |
|
} |
|
|
|
|
|
|
124
|
|
|
|
|
125
|
|
|
/** |
|
126
|
|
|
* Gets all of the available event types |
|
127
|
|
|
* |
|
128
|
|
|
* @return AuthnetWebhooksResponse |
|
129
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
130
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
131
|
|
|
*/ |
|
132
|
1 |
|
public function getEventTypes(): object |
|
133
|
|
|
{ |
|
|
|
|
|
|
134
|
1 |
|
$this->endpoint = 'eventtypes'; |
|
135
|
1 |
|
$this->url = sprintf('%s%s', $this->url, $this->endpoint); |
|
|
|
|
|
|
136
|
1 |
|
return $this->getByUrl($this->url); |
|
137
|
|
|
} |
|
|
|
|
|
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* List all of your webhooks |
|
141
|
|
|
* |
|
142
|
|
|
* @return AuthnetWebhooksResponse |
|
143
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
144
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
145
|
|
|
*/ |
|
146
|
1 |
|
public function getWebhooks(): object |
|
147
|
|
|
{ |
|
|
|
|
|
|
148
|
1 |
|
$this->endpoint = 'webhooks'; |
|
149
|
1 |
|
$this->url = sprintf('%s%s', $this->url, $this->endpoint); |
|
|
|
|
|
|
150
|
1 |
|
return $this->getByUrl($this->url); |
|
151
|
|
|
} |
|
|
|
|
|
|
152
|
|
|
|
|
153
|
|
|
/** |
|
154
|
|
|
* Get a webhook |
|
155
|
|
|
* |
|
156
|
|
|
* @param string $webhookId Webhook ID to be retrieved |
|
|
|
|
|
|
157
|
|
|
* @return AuthnetWebhooksResponse |
|
|
|
|
|
|
158
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
159
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
160
|
|
|
*/ |
|
161
|
1 |
|
public function getWebhook(string $webhookId): object |
|
162
|
|
|
{ |
|
|
|
|
|
|
163
|
1 |
|
$this->endpoint = 'webhooks'; |
|
164
|
1 |
|
$this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId); |
|
|
|
|
|
|
165
|
1 |
|
return $this->getByUrl($this->url); |
|
166
|
|
|
} |
|
|
|
|
|
|
167
|
|
|
|
|
168
|
|
|
/** |
|
169
|
|
|
* GET API request |
|
170
|
|
|
* |
|
171
|
|
|
* @param string $url API endpoint to hit |
|
|
|
|
|
|
172
|
|
|
* @return object |
|
|
|
|
|
|
173
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
174
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
175
|
|
|
*/ |
|
176
|
3 |
|
private function getByUrl(string $url): object |
|
|
|
|
|
|
177
|
|
|
{ |
|
|
|
|
|
|
178
|
3 |
|
$response = $this->get($url); |
|
179
|
3 |
|
return new AuthnetWebhooksResponse($response); |
|
180
|
|
|
} |
|
|
|
|
|
|
181
|
|
|
|
|
182
|
|
|
/** |
|
183
|
|
|
* Updates webhook event types |
|
184
|
|
|
* |
|
185
|
|
|
* @param string $webhookId Webhook ID to be modified |
|
|
|
|
|
|
186
|
|
|
* @param string $webhookUrl URL of where webhook notifications will be sent |
|
|
|
|
|
|
187
|
|
|
* @param array $eventTypes Array of event types to be added/removed |
|
|
|
|
|
|
188
|
|
|
* @param string $status Status of webhooks to be modified [active/inactive] |
|
|
|
|
|
|
189
|
|
|
* @return AuthnetWebhooksResponse |
|
|
|
|
|
|
190
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
191
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
192
|
|
|
*/ |
|
193
|
1 |
|
public function updateWebhook(string $webhookId, string $webhookUrl, array $eventTypes, string $status = 'active'): object |
|
|
|
|
|
|
194
|
|
|
{ |
|
|
|
|
|
|
195
|
1 |
|
$this->endpoint = 'webhooks'; |
|
|
|
|
|
|
196
|
1 |
|
$this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId); |
|
|
|
|
|
|
197
|
|
|
$request = [ |
|
|
|
|
|
|
198
|
1 |
|
'url' => $webhookUrl, |
|
|
|
|
|
|
199
|
1 |
|
'eventTypes' => $eventTypes, |
|
|
|
|
|
|
200
|
1 |
|
'status' => $status |
|
|
|
|
|
|
201
|
|
|
]; |
|
|
|
|
|
|
202
|
1 |
|
$this->requestJson = json_encode($request); |
|
203
|
1 |
|
$response = $this->put($this->url, $this->requestJson); |
|
|
|
|
|
|
204
|
1 |
|
return new AuthnetWebhooksResponse($response); |
|
205
|
|
|
} |
|
|
|
|
|
|
206
|
|
|
|
|
207
|
|
|
/** |
|
208
|
|
|
* Delete a webhook |
|
209
|
|
|
* |
|
210
|
|
|
* @param string $webhookId Webhook ID to be deleted |
|
|
|
|
|
|
211
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
212
|
|
|
*/ |
|
|
|
|
|
|
213
|
1 |
|
public function deleteWebhook(string $webhookId): void |
|
214
|
|
|
{ |
|
|
|
|
|
|
215
|
1 |
|
$this->endpoint = 'webhooks'; |
|
216
|
1 |
|
$this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId); |
|
|
|
|
|
|
217
|
1 |
|
$this->delete($this->url); |
|
218
|
1 |
|
} |
|
|
|
|
|
|
219
|
|
|
|
|
220
|
|
|
/** |
|
221
|
|
|
* Retrieve Notification History |
|
222
|
|
|
* |
|
223
|
|
|
* @param int $limit Default: 1000 |
|
|
|
|
|
|
224
|
|
|
* @param int $offset Default: 0 |
|
|
|
|
|
|
225
|
|
|
* @return AuthnetWebhooksResponse |
|
|
|
|
|
|
226
|
|
|
* @throws AuthnetInvalidJsonException |
|
|
|
|
|
|
227
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
228
|
|
|
*/ |
|
229
|
1 |
|
public function getNotificationHistory(int $limit = 1000, int $offset = 0): object |
|
|
|
|
|
|
230
|
|
|
{ |
|
|
|
|
|
|
231
|
1 |
|
$this->endpoint = 'notifications'; |
|
232
|
1 |
|
$this->url = sprintf('%s%s', $this->url, $this->endpoint); |
|
|
|
|
|
|
233
|
1 |
|
$response = $this->get( |
|
|
|
|
|
|
234
|
1 |
|
$this->url, [ |
|
235
|
1 |
|
'offset' => $offset, |
|
|
|
|
|
|
236
|
1 |
|
'limit' => $limit |
|
|
|
|
|
|
237
|
|
|
] |
|
|
|
|
|
|
238
|
|
|
); |
|
239
|
1 |
|
return new AuthnetWebhooksResponse($response); |
|
240
|
|
|
} |
|
|
|
|
|
|
241
|
|
|
|
|
242
|
|
|
/** |
|
243
|
|
|
* Tells the handler to make the API call to Authorize.Net |
|
244
|
|
|
* |
|
245
|
|
|
* @return string |
|
246
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
247
|
|
|
*/ |
|
248
|
4 |
|
private function handleResponse(): string |
|
|
|
|
|
|
249
|
|
|
{ |
|
|
|
|
|
|
250
|
4 |
|
if (!$this->processor->error) { |
|
|
|
|
|
|
251
|
1 |
|
return $this->processor->response; |
|
252
|
|
|
} |
|
|
|
|
|
|
253
|
3 |
|
$response = json_decode($this->processor->response, false); |
|
|
|
|
|
|
254
|
3 |
|
$error_message = sprintf('(%u) %s: %s', $response->status, $response->reason, $response->message); |
|
|
|
|
|
|
255
|
|
|
|
|
256
|
3 |
|
throw new AuthnetCurlException(sprintf('Connection error: %s', $error_message)); |
|
|
|
|
|
|
257
|
|
|
} |
|
|
|
|
|
|
258
|
|
|
|
|
259
|
|
|
/** |
|
260
|
|
|
* Make GET request via Curl |
|
261
|
|
|
* |
|
262
|
|
|
* @param string $url |
|
|
|
|
|
|
263
|
|
|
* @param array $params |
|
|
|
|
|
|
264
|
|
|
* @return string |
|
|
|
|
|
|
265
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
266
|
|
|
* |
|
267
|
|
|
* @codeCoverageIgnore |
|
268
|
|
|
*/ |
|
269
|
|
|
private function get(string $url, array $params = []): string |
|
|
|
|
|
|
270
|
|
|
{ |
|
|
|
|
|
|
271
|
|
|
$this->processor->get($url, $params); |
|
272
|
|
|
return $this->handleResponse(); |
|
273
|
|
|
} |
|
|
|
|
|
|
274
|
|
|
|
|
275
|
|
|
/** |
|
276
|
|
|
* Make POST request via Curl |
|
277
|
|
|
* |
|
278
|
|
|
* @param string $url API endpoint |
|
|
|
|
|
|
279
|
|
|
* @param string $request JSON request payload |
|
|
|
|
|
|
280
|
|
|
* @return string |
|
|
|
|
|
|
281
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
282
|
|
|
* |
|
283
|
|
|
* @codeCoverageIgnore |
|
284
|
|
|
*/ |
|
285
|
|
|
private function post(string $url, string $request): string |
|
|
|
|
|
|
286
|
|
|
{ |
|
|
|
|
|
|
287
|
|
|
$this->processor->post($url, $request); |
|
288
|
|
|
return $this->handleResponse(); |
|
289
|
|
|
} |
|
|
|
|
|
|
290
|
|
|
|
|
291
|
|
|
/** |
|
292
|
|
|
* Make PUT request via Curl |
|
293
|
|
|
* |
|
294
|
|
|
* @param string $url API endpoint |
|
|
|
|
|
|
295
|
|
|
* @param string $request JSON request payload |
|
|
|
|
|
|
296
|
|
|
* @return string |
|
|
|
|
|
|
297
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
298
|
|
|
* |
|
299
|
|
|
* @codeCoverageIgnore |
|
300
|
|
|
*/ |
|
301
|
|
|
private function put(string $url, string $request): string |
|
|
|
|
|
|
302
|
|
|
{ |
|
|
|
|
|
|
303
|
|
|
$this->processor->put($url, $request, true); |
|
|
|
|
|
|
304
|
|
|
return $this->handleResponse(); |
|
305
|
|
|
} |
|
|
|
|
|
|
306
|
|
|
|
|
307
|
|
|
/** |
|
308
|
|
|
* Make DELETE request via Curl |
|
309
|
|
|
* |
|
310
|
|
|
* @param string $url API endpoint |
|
|
|
|
|
|
311
|
|
|
* @return string |
|
|
|
|
|
|
312
|
|
|
* @throws AuthnetCurlException |
|
|
|
|
|
|
313
|
|
|
* |
|
314
|
|
|
* @codeCoverageIgnore |
|
315
|
|
|
*/ |
|
316
|
|
|
private function delete(string $url): string |
|
|
|
|
|
|
317
|
|
|
{ |
|
|
|
|
|
|
318
|
|
|
$this->processor->delete($url, [], true); |
|
|
|
|
|
|
319
|
|
|
return $this->handleResponse(); |
|
320
|
|
|
} |
|
|
|
|
|
|
321
|
|
|
|
|
322
|
|
|
/** |
|
323
|
|
|
* Sets the handler to be used to handle our API call. Mainly used for unit testing as Curl is used by default. |
|
|
|
|
|
|
324
|
|
|
* |
|
325
|
|
|
* @param Curl $processor |
|
|
|
|
|
|
326
|
|
|
*/ |
|
|
|
|
|
|
327
|
1 |
|
public function setProcessHandler(Curl $processor): void |
|
328
|
|
|
{ |
|
|
|
|
|
|
329
|
1 |
|
$this->processor = $processor; |
|
330
|
1 |
|
} |
|
|
|
|
|
|
331
|
|
|
|
|
332
|
|
|
/** |
|
333
|
|
|
* Gets the request sent to Authorize.Net in JSON format for logging purposes |
|
334
|
|
|
* |
|
335
|
|
|
* @return string transaction request sent to Authorize.Net in JSON format |
|
336
|
|
|
*/ |
|
337
|
1 |
|
public function getRawRequest(): string |
|
338
|
|
|
{ |
|
|
|
|
|
|
339
|
1 |
|
return $this->requestJson; |
|
340
|
|
|
} |
|
|
|
|
|
|
341
|
|
|
} |
|
|
|
|
|
|
342
|
|
|
|
stymiee /
authnetjson
Loading history...
