traackr/traackr-api-php

Traackr API PHP Library

Traackr API - PHP Client

, _(*1)

Introduction

This is a PHP implementation of the Traackr API. Documentation for this PHP client is available here: http://traackr.github.io/traackr-api-docs.
For documentation for the Traackr API itself, see: http://api.docs.traackr.com., _(*2)

Installation

You can clone this GitHub repository to get the latest version of the code., _(*3)

This library is also available via Composer if that's what you use to manage your dependencies. To do this, simply add this to your composer.json file:, _(*4)

"minimum-stability": "dev",
"require": {
    "traackr/traackr-api-php": "dev-master"
}

Usage

You will need an API key to make use this library. Contact api@traackr.com to get your key., _(*5)

Include the library

You include this library with:, _(*6)

require_once('lib/TraackrApi.php');

If you are using Composer the autoload functionality should automatically load the appropriate PHP files (i.e. require 'vendor/autoload.php' will load the library files)., _(*7)

Set your API key

To set your API key use:, _(*8)

TraackrApi::setApiKey(<your-api-key>);

Some calls require a Customer Key (see documentation). You do not need to pass this key to these calls. You can set (once and for all) your Customer Key with:, _(*9)

TraackrApi::setCustomerKey(<your-customer-key);

The client library will take care of including your customer key when needed., _(*10)

Note that you can also specify your API key and customer key via environment variables. See the unit tests section., _(*11)

API calls

All API calls map to static functions with parameters matching the API call parameters (see documentation). For instance to call /influencers/show you can use:, _(*12)

Influencers::show(<influencer-uid>);

Logging

You can tie the client's internal logging into your own application's logging by creating an implementation of the ApiLoggingInterface. Here's an example from CakePHP:, _(*13)

class ApiLogger implements Traackr\ApiLoggerInterface
{
   private $parentObj;

   public function __construct($obj) {
      $this->parentObj = $obj;
   }

   public function debug($string) {
      $this->parentObj->log($string, LOG_DEBUG);
   }

   public function error($string) {
      $this->parentObj->log($string, LOG_WARNING);
   }
}

Then, create an instance of your implementation before any API calls are made (e.g. in a constructor):, _(*14)

Traackr\TraackrApi::setLogger(
   new ApiLogger($this)
);

Unit Tests

Setup

To run unit tests, you will need to install dependencies required by this project. First, install Composer locally:, _(*15)

$ curl -sS https://getcomposer.org/installer | php

Then install dependencies:, _(*16)

$ php composer.phar install

Running the tests

The unit tests come with a public API key that you can use to run the unit tests. However the API key provided in the unit tests is only allowed to access read-only end points (i.e. API calls that do not add, modify or delete any data).
To run these read-only tests you can execute:, _(*17)

./bin/phpunit --group read-only test

If you try to run the entire test suite with this public API key you will get errors when trying to access functions that change data., _(*18)

Running the entire test suite

To run the entire test suite you will need an API key that has full access to the API. You can request one by emailing api-support@traackr.com., _(*19)

Before you run unit tests, you need to specify an API key and a Customer key. These 2 values can be specified via ENV variables (so they don't have to be hardcoded in the unit tests)., _(*20)

# export TRAACKR_API_KEY=<your-api-key>
# export TRAACKR_CUSTOMER_KEY=<your-customer-key>

Run the entire test suite:, _(*21)

./bin/phpunit test