README

This package provides Quickbooks Online OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require compwright/oauth2-quickbooks-online league/oauth2-client

Usage

Usage is the same as The League's OAuth client, using \Compwright\OAuth2_Quickbooks_Online\Provider as the provider.

Example: Authorization Code Flow

$provider = new Compwright\OAuth2_Quickbooks_Online\Provider([
    'clientId'      => '{quickbooks-online-client-id}',
    'clientSecret'  => '{quickbooks-online-client-secret}',
    'redirectUri'   => 'https://example.com/callback-url'
]);

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
if (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {
    unset($_SESSION['oauth2state']);
    exit('Invalid state');
}

// Get an access token using the authorization code grant
$token = $provider->getAccessToken('authorization_code', [
    'code' => $_GET['code'],
    'state' => $_GET['state'],
    'realmId' => $_GET['realmId'], // required for getResourceOwner() to work
]);

// You can look up a users profile data
$user = $provider->getResourceOwner($token);
printf('Hello %s!', $user->getId());

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

Testing

$ make test

Contributing

Please see CONTRIBUTING for details.

Credits

This package was forked from chadhutchins/oauth2-quickbooks, which appeared to be abandoned as of December 2023.

License

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

compwright / oauth2-quickbooks-online

Maintainers

Details