fromtheoutfit/bigboard-sdk-php

PHP SDK for bigboard.us

v1.0.2 2014-07-21 17:18 UTC

Requires

• php: >=5.3.0
• guzzle/guzzle: 3.x

MIT

• The Outfit, Inc.
• Brenden Tamilio

README

#BigBoard SDK for PHP

This SDK provides a simple interface to the [BigBoard API] (https://bigboard.us/api).

[BigBoard] (https://bigboard.us/) is a service that aggregates point-in-time events from other web services (and your own custom events) into a visually pleasing dashboard, allowing you to see what's really happening.

##Installation Installation via [Composer] (http://getcomposer.org) is highly recommended; update your project's composer.json file to include the BigBoard SDK:

{
    "require": {
        "fromtheoutfit/bigboard-sdk-php": "dev-master"
    }
}

##Basic Usage

require 'vendor/autoload.php';

// See BigBoard's service settings UI. 
// Connect an App and paste your token here:
$api_key = "<Your API Access Token Here>";

$client = new BigBoardSDK\APIClient ($api_key);

// Get My Account
$my_account = $client->getWhoAmI();
var_export ($my_account);


// Post Events
$events = array (
	array (
	    "person_id" => "[e-mail]",
	    "person_label" => "Peter Gibbons",
	    "summary" => "Weekly TPS Report filed",
	    "time" => (time()-300), 
	    "label" => "TPS Reports"
	),
	array (
	    "person_id" => "[e-mail]",
	    "person_label" => "Bill Lundbergh",
	    "summary" => "Report Rejected. Comment: Please include cover sheet. Mmmmkay?",
	    "time" => time(),
	    "label" => "TPS Reports",
            "url": "http://www.youtube.com/watch?v=Fy3rjQGc6lA"
	),


);

$status = $client->sendEvents($events);
var_export ($status);

##Documentation More information on the BigBoard API is available at https://bigboard.us/api.