zerospam / oauth2-freshbooks
Freshbook OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Installs: 12 286
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 1
Open Issues: 2
Requires
- league/oauth2-client: ^2.0
Requires (Dev)
- php: >= 7.1
- mockery/mockery: ^1.1
- phpunit/phpunit: ^7.1
- satooshi/php-coveralls: ^2.0
- squizlabs/php_codesniffer: ^3.2
README
This package provides Freshbooks OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require zerospam/oauth2-freshbooks
Usage
Usage is the same as The League's OAuth client, using \ZEROSPAM\OAuth2\Client\Provider\FreshBooks
as the provider.
Authorization Code Flow
$provider = new ZEROSPAM\OAuth2\Client\Provider\FreshBooks([ 'clientId' => '{freshbooks-client-id}', 'clientSecret' => '{freshbooks-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 } 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'] ]); // Optional: Now you have a token you can look up a users profile data try { // We got an access token, let's now get the user's details $user = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $user->getId()); } catch (Exception $e) { // Failed to get user details exit('Oh dear...'); } // Use this to interact with an API on the users behalf echo $token->getToken(); }
Refreshing a Token
$provider = new ZEROSPAM\OAuth2\Client\Provider\FreshBooks([ 'clientId' => '{freshbooks-client-id}', 'clientSecret' => '{freshbooks-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]); $grant = new \League\OAuth2\Client\Grant\RefreshToken(); $token = $provider->getAccessToken($grant, ['refresh_token' => $token->refreshToken]);
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.