prosperworks/php-sdk-v1

Prosperworks PHP SDK

1.0.0 2015-08-11 17:41 UTC

Requires

• php: >=5.4.0
• ext-mbstring: *

Requires (Dev)

• guzzlehttp/guzzle: ~5.0
• mockery/mockery: ~0.8
• phpunit/phpunit: ~4.0

Suggests

• guzzlehttp/guzzle: Allows for implementation of the Guzzle HTTP client

GPL-2.0

• radoneman

• api
• sdk
• prosperworks

README

A PHP client (fancy named SDK) to access Prosperworks API. Default HTTP library is CURL but it works with Guzzle too.

Note: this is not an official Prosperworks package; all product names, logos, and brands are property of their respective owners.

Installation

With Composer. Add the Prosperworks PHP SDK package to your composer.json file.

{
    "require": {
        "prosperworks/php-sdk-v1": "~1.0"
    }
}

Usage

Note: PHP 5.4 or greater is required.

Using

$config = array(
    'access_token' => 'YOURACCESSTOKENHERE',
    'user_email' => '[e-mail]'
    // 'client_http' => 'guzzle' // if you want to use guzzle 5.0    
);

$app = new Prosperworks($config);
$result = $app->post('companies/search');
print_r($result);

Tests

1. Composer is a prerequisite for running the tests. Install composer globally, then run composer install to install required files.
2. Get API credentials from Prosperworks and update the $config array.
3. The tests can be executed by running this command from the root directory:

$ ./vendor/bin/phpunit