Smartsupp REST API PHP client

This is a simple Smartsupp REST API wraper writen in PHP. It has intuitive design to create, delete, update and get resources.

• https://www.smartsupp.com/
• Resources REST API documentation This is documnentation of the Smartsupp Resources. PHP wrapper generates all kind of REST requests by intuitive fluent style.

Get Started

Here is an example on how to use it:

$api = new Smartsupp\Rest\Api(YOUR_API_KEY);

// get accounts list
$accountListResponse = $api->accounts()
	->send();

// create account
$accountResponse = $api->accounts()
	->create(array(
  		'title' => 'My account',
		'lang' => 'cs'
	));

// create user in account
$userResponse = $api->accounts($accountResponse->id)
	->users()
	->create(array(
		'fullname' => 'Test Create',
		'nickname' => 'Nick name',
		'password' => 'pass1234',
		'email' => 'john.doe.create@tester.loc',
		'lang' => 'en'
	));

// update user in account
$userUpdateResponse = $api->accounts($accountResponse->id)
	->users($userResponse->id)
	->update(array(
		'nickname' => 'John Doe'
	));

// get user in account  
$userGetResponse = $api->accounts($accountResponse->id)
	->users($userResponse->id))
	->get();

// get list of users in account
$usersListResponse = $api->accounts($accountResponse->id)
	->users()
	->send();

// delete user
$api->accounts($accountResponse->id)
	->users($userResponse->id))
	->delete();

From this example, you can learn the following:

• If you want to works with resources you should pass resource ID as parameter.
• Allowed methods are: "get", "update", "create", "delete", "send"
• Every response has code and values
• Every api call returns response objects with code and values

Access to response

To get response info you can use this properties

$response = $api->accounts($accountId)
	->users()
	->send();

// read http response code
echo $response->code; // 200

// read response variables
print_R($response->values); 
// array(
//	'records'=> array(
//		0 => array('id'=>123, 'nickname'=>'John Doe', 'role'=>'agent', ...), 
// 		1 => array(...), 
//		...
//	)
// );

• code Http response code
• values Response JSON converted to array

Into response values you can access by __get property like:

$user = $api->accounts($accountId)->users($userId)->get();
echo $user->id; // show user id
echo $user->values['id']; // show user id
echo $user->getValue('id'); // show user id

But dont forget, returned values is array, so respect it like in this example ($user['id'], not $user->id):

$response = $api->accounts($accountId)->users()->send();
foreach($response->records as $user) {
	// do something with $user, e.g. delete user
	$api->accounts($accountId)->users($user['id'])->delete();
}

Copyright

Copyright (c) 2016 Smartsupp.com, s.r.o.