traitify/client

Traitify Api Client

1.0.0.x-dev 2014-06-17 00:00 UTC

Requires (Dev)

• phpunit/phpunit: 4.3.*

MIT

• Carson Wright

• api
• client
• traitify
• personality

README

This is a helper library for the Traitify API - https://developer.traitify.com/

Installing via Composer

The recommended way to install the Traitify library is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

# Add the library as a dependency
php composer.phar require traitify/client dev-master

or alternatively, you can add it directly to your composer.json file.

{
    "require": {
        "traitify/client": "dev-master"
    }
}

Then install via Composer:

composer install

Finally, require Composer's autoloader in your PHP script:

require __DIR__.'/vendor/autoload.php';

This library is best used with Traitify JS

http://traitify.github.io/traitify-js/

Secret Key Required

For instructions on obtaining a public key visit: https://developer.traitify.com

Using The Traitify PHP Client Library:

Create an instance of the Client

$client = new Traitify\Client([
  'host'=>'api-sandbox.traitify.com', /* Example Host */ 
  'version'=>'v1', /* Example Version */
  'secretKey'=>'34aeraw23-3a43a32-234a34as42' /* Example Secret Key */
]);
$client->createAssessment("career-deck");

Get Slides

$client = new Traitify\Client([
  'host'=>'api-sandbox.traitify.com', /* Example Host */ 
  'version'=>'v1', /* Example Version */
  'secretKey'=>'34aeraw23-3a43a32-234a34as42' /* Example Secret Key */
]);
$client->getSlides('a45rasw3-45s3a32-234aas45'); /* Example Assessment Id */

Get Decks

$client = new Traitify\Client([
  'host'=>'api-sandbox.traitify.com', /* Example Host */ 
  'version'=>'v1', /* Example Version */
  'secretKey'=>'34aeraw23-3a43a32-234a34as42' /* Example Secret Key */
]);
$client->getDecks();

Get Personality Types

$client = new Traitify\Client([
  'host'=>'api-sandbox.traitify.com', /* Example Host */ 
  'version'=>'v1', /* Example Version */
  'secretKey'=>'34aeraw23-3a43a32-234a34as42' /* Example Secret Key */
]);
$client->getPersonalityTypes('a45rasw3-45s3a32-234aas45'); /* Example Assessment Id */

Get Personality Traits

$client = new Traitify\Client([
  'host'=>'api-sandbox.traitify.com', /* Example Host */ 
  'version'=>'v1', /* Example Version */
  'secretKey'=>'34aeraw23-3a43a32-234a34as42' /* Example Secret Key */
]);
$client->getPersonalityTraits('a45rasw3-45s3a32-234aas45'); /* Example Assessment Id */

Contributing

Building, Testing and Bundling:

Installing PHPUnit https://phpunit.de/manual/current/en/installation.html

$ composer install
$ phpunit tests/traitify_client.php