kangaroorewards / kangaroorewards-php-sdk

v3.0.0 2026-08-21 20:38 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-json: *
• guzzlehttp/guzzle: ^7.9

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.4
• phpunit/phpunit: ^10.5 || ^11.5 || ^12.0 || ^13.0
• squizlabs/php_codesniffer: ^3.11

MIT

• Valentin Ursuleac

• api
• oauth
• oauth2
• loyalty
• kangaroo
• Kangaroo Rewards

Published on Packagist.org on 2026-08-21 20:42 UTC

README

Requirements

The following versions of PHP are supported.

• PHP 8.1
• PHP 8.2
• PHP 8.3
• PHP 8.4
• PHP 8.5

Requires the curl and json extensions, and guzzlehttp/guzzle ^7.9.

Running PHP 7.x or older? Stay on the 2.x releases.

Installation

composer require kangaroorewards/kangaroorewards-php-sdk:^3.0

Usage

use KangarooRewards\Api\KangarooApi;

$api = new KangarooApi([
    'access_token' => $accessToken,
]);

$resourceOwner = $api->me();

$customer = $api->getCustomer($customerId, ['include' => ['balance']]);

$offers = $api->getOffers();

Options

Option	Type	Default	Description
access_token	string	required	OAuth 2.0 access token.
base_api_url	string	https://api.kangaroorewards.com	API root. A path prefix (e.g. https://host/v1) is preserved.
user_agent	string	API Client/1.0	Value of the User-Agent header.
headers	array	[]	Extra headers, merged over (and able to override) the defaults.
http_client	ClientInterface	a new GuzzleHttp\Client	Bring your own Guzzle client — handy for retries, proxies and testing.

$api = new KangarooApi([
    'access_token' => $accessToken,
    'base_api_url' => 'https://api.kangaroorewards.com',
    'user_agent'   => 'My App/1.0',
    'headers'      => ['X-Application-Key' => $applicationKey],
]);

Available methods

$api->me($options);
$api->getCustomers($options);
$api->getCustomer($id, $options);
$api->createCustomer($data);
$api->updateCustomer($id, $data);
$api->getCustomerTransactions($id, $options);
$api->getCustomerNotifications($id, $options);
$api->getBranches($options);
$api->getOffers($options);
$api->getProducts($options);

Every method returns the decoded JSON body as an associative array.

Error handling

Situation	Exception
Missing/invalid constructor options	KangarooRewards\Api\Exception\InvalidArgumentException
Response body is not decodable JSON	KangarooRewards\Api\Exception\InvalidResponseException
HTTP 4xx / 5xx	GuzzleHttp\Exception\ClientException / ServerException

Both SDK exceptions implement KangarooRewards\Api\Exception\ExceptionInterface and extend the SPL classes the 2.x SDK used, so existing catch (\Exception $e) and catch (\InvalidArgumentException $e) blocks keep working.

use KangarooRewards\Api\Exception\ExceptionInterface as KangarooException;

try {
    $customer = $api->getCustomer($customerId);
} catch (KangarooException $e) {
    // SDK-level failure
} catch (\GuzzleHttp\Exception\RequestException $e) {
    // Transport / HTTP status failure
}

Injecting a custom HTTP client

use GuzzleHttp\Client;

$api = new KangarooApi([
    'access_token' => $accessToken,
    'http_client'  => new Client(['timeout' => 5.0]),
]);

The SDK always sends absolute URLs built from base_api_url, so an injected client behaves exactly like the built-in one.

Testing

composer install
composer test
composer lint
composer check

Upgrading from 2.x

See CHANGELOG.md. The public API is unchanged; the breaking changes are the raised PHP and Guzzle requirements.

Credits

• Valentin Ursuleac

License

The MIT License (MIT). Please see License File for more information.