README

This package provides Sage Business Cloud OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

This package requires PHP >= 7.4.

Installation

To install, use composer:

composer require olsgreen/oauth2-sage-business-cloud

Usage

Usage is the same as The League's OAuth client, using \Olsgreen\OAuth2\Client\Provider\SageBusinessCloud as the provider.

Authorization Code Flow

$provider = new Olsgreen\OAuth2\Client\Provider\SageBusinessCloud([
    'clientId'          => '{sage-client-id}',
    'clientSecret'      => '{sage-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
    'locale'            => 'en-GB', // Optional
    'country'           => 'gb', // Optional
]);

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

Countries & Locales

See https://developer.sage.com/accounting/guides/authenticating/authentication/ for a current list of supported countries and locales.

Testing

$ ./vendor/bin/phpunit

License

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

olsgreen / oauth2-sage-business-cloud

Maintainers

Details