drewm / frontapp
Super-simple, minimum abstraction FrontApp API wrapper
Installs: 98 942
Dependents: 0
Suggesters: 0
Security: 0
Stars: 6
Watchers: 3
Forks: 4
Open Issues: 2
Requires
- php: >=5.4
- ext-curl: *
This package is auto-updated.
Last update: 2024-11-24 05:08:17 UTC
README
Super-simple, minimum abstraction Front API wrapper, in PHP.
In the style of my MailChimp wrapper, this lets you get from the FrontApp API docs to the code as directly as possible.
Requires PHP 5.4 and curl.
Installation
You can install frontapp using Composer:
composer require drewm/frontapp
You will then need to:
- run
composer install
to get these dependencies added to your vendor directory - add the autoloader to your application with this line:
require("vendor/autoload.php")
Examples
Start by use
-ing the class and creating an instance with your API key
use \DrewM\FrontApp\FrontApp; $FrontApp = new FrontApp('abc123abc123abc123abc123abc123');
Then, list all your inboxes (with a get
on the inboxes
method)
$result = $FrontApp->get('inboxes'); print_r($result);
Create an inbox (with a post
to the inboxes
method):
$result = $FrontApp->post("inboxes", [ 'name' => 'Support' ]); print_r($result);
Update a channel member with more information (using patch
to update):
$channel_id = 'cha_123'; $result = $FrontApp->patch("channels/$channel_id", [ 'settings' => [ 'webhook_url' => 'https://example.com/hook' ] ]); print_r($result);
Remove a contact using the delete
method:
$contact_id = 'ctc_123'; $FrontApp->delete("contacts/$contact_id");
Quickly test for a successful action with the success()
method:
$result = $FrontApp->get('inboxes'); if ($FrontApp->success()) { print_r($result); } else { echo $FrontApp->getLastError(); }
Troubleshooting
To get the last error returned by either the HTTP client or by the API, use getLastError()
:
echo $FrontApp->getLastError();
For further debugging, you can inspect the headers and body of the response:
print_r($FrontApp->getLastResponse());
If you suspect you're sending data in the wrong format, you can look at what was sent to FrontApp by the wrapper:
print_r($FrontApp->getLastRequest());