serverdensity / sd-api-wrapper
A php wrapper for the Server Density API v2
This package's canonical repository appears to be gone and the package has been frozen as a result.
Requires
- php: >=5.3.2
- ext-curl: *
- guzzlehttp/guzzle: ~5.2
Requires (Dev)
- phpunit/phpunit: ~4.0
README
To get this up and running you need to to use composer.
Download composer
curl -s http://getcomposer.org/installer | php
Then install the dependencies
php composer.phar install
To run the tests run the following command in the terminal
vendor/phpunit/phpunit/phpunit test
To run functional tests you need to type in the following. This will only run the functional tests. You need to submit your own token for this to work though. Which you can do in the following path: test/serverdensity/Tests/functional/TestCase.
vendor/phpunit/phpunit/phpunit --group functional test
How to use it
<?php
use serverdensity\Client;
$client = new Client();
$client->authenticate('auth_token_here');
// A basic call to view devices
$devices = $client->api('devices')->all();
A longer list of examples can be found among our api docs
Installing the wrapper
Copy the json below into composer.json and run php composer.phar install. You can find the package itself on the packagist
{
"require": {
"serverdensity/sd-api-wrapper": ">=0.7.4"
}
}
The following verbs exist
- Create - creating a resource, takes an array
- Delete - deleting a resource, takes an ID
- View - viewing a single resource, taken an ID
- All - view all resources
- Update - updating a resource, takes fields that needs updating.
- Search (for some endpoints).