pbxg33k / oauth2-exact-provider
Exact Online 2.0 Client Provider for The PHP Leage OAuth2-Client
Installs: 3 572
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- league/oauth2-client: ~0.10.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
This package is auto-updated.
Last update: 2024-11-08 07:05:47 UTC
README
This package provides support for authenticating with Exact Online's OAuth2 provider using PHP League's OAuth 2.0 Client.
Demo
Click here to see an online demonstration which allows you to authenticate using an Exact account.
Installation
To install, use composer:
composer require pbxg33k/oauth2-exact-provider
Usage
Usage is the same as The League's OAuth client, using Pbxg33k\OAuth2\Client\Provider\Exactonline
as the provider.
Authorization Code Flow
$provider = new Pbxg33k\OAuth2\Client\Provider\Exactonline([ 'clientId' => '{exact-client-id}', 'clientSecret' => '{exact-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->state; 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 $userDetails = $provider->getUserDetails($token); // Use these details to create a new profile printf('Hello %s!', $userDetails->firstName); } catch (Exception $e) { // Failed to get user details exit('Oh dear...'); } // Use this to interact with an API on the users behalf echo $token->accessToken; }
Refreshing a Token
$provider = new Pbxg33k\OAuth2\Client\Provider\Exactonline([ 'clientId' => '{zenpayroll-client-id}', 'clientSecret' => '{zenpayroll-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]); $grant = new \League\OAuth2\Client\Grant\RefreshToken(); $token = $provider->getAccessToken($grant, ['refresh_token' => $refreshToken]);