Official Aboardly API library client for PHP
This library is generated by alpaca and then modified by hand, hence why some things seem over engineered.
Make sure you have composer installed.
Add the following to your composer.json
{
"require": {
"aboardly/aboardly": "1.*"
}
}
Update your dependencies
$ php composer.phar update
This package follows the
PSR-0
convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.
Works with [ 5.4 + ]
<?php
// This file is generated by Composer
require_once 'vendor/autoload.php';
// Then we instantiate a client (as shown below)
Using this api without authentication gives an error
$auth = array('username' => 'api_key', 'password' => 'api_secret');
$client = new Aboardly\Client($auth);
All the callbacks provided to an api call will recieve the response as shown below
$response = $client->klass->method('args', $methodOptions);
$response->code;
// >>> 200
$response->headers;
// >>> array('x-server' => 'apache')
Updates customer data. If customer does not exist it is created.
The following arguments are required:
- customer_id: Customer identifier - an identifier that can 1:1 match to the user in your own systems.
- options.email: Customer email - required
- options: Data about customer like first_name, last_name, email (required)
$options = array('email' => '[email protected]', 'name' => 'John Smith');
$response = $client->customers->upsert("customer_id", $options);
Creates a new event for a customer
The following arguments are required:
- customer_id: Customer identifier - an identifier that can 1:1 match to the user in your own systems.
- event_name: Event name (e.g. logged_in, signed_up, added_funds)
$response = $events->create("customer_id", "event_name");