liftkeeper/oauth2-tsheets

TSheets by QuickBooks OAuth 2.0 Client Provider for The PHP League OAuth2-Client

1.0.3 2021-07-06 14:28 UTC

Requires

• php: >=5.6.0
• league/oauth2-client: 1.*|2.*

MIT

• Benjamin Simon

• authorization
• Authentication
• oauth
• oauth2
• SSO
• identity
• single sign on
• tsheets
• tsheets quickbooks
• tsheets api

README

This package provides TSheets by QuickBooks OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require liftkeeper/oauth2-tsheets

Usage

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

TSheets by QuickBooks: Obtaining an API Access Token

Authorization Code Flow

<?php

require '{__PATH_TO_YOUR_VENDOR_DIRECTORY__}/autoload.php';

session_start();

$provider = new \Liftkeeper\OAuth2\Client\Provider\TSheets([
	'clientId' => '{__TSHEETS-CLIENT-ID__}',
	'clientSecret' => '{__TSHEETS-CLIENT-SECRET__}',
	'redirectUri' => '{__YOUR-CALLBACK-URL__}',
]);

if (!isset($_GET['code'])) {
	$authUrl = $provider->getAuthorizationUrl();
	$_SESSION['oauth2state'] = $provider->getState();
	header('Location: ' . $authUrl);
	exit;

} else if (empty($_GET['state']) || ( $_GET['state'] !== $_SESSION['oauth2state'] )) {
	unset($_SESSION['oauth2state']);
	exit('Invalid state');

} else {
	try {
		$accessToken = $provider->getAccessToken('authorization_code', [
			'code' => $_GET['code'],
		]);

		echo '<pre>';
		echo 'Token: ' . $accessToken->getToken() . PHP_EOL;
		echo 'RefreshToken: ' . $accessToken->getRefreshToken() . PHP_EOL;
		echo 'Expires: ' . $accessToken->getExpires() . PHP_EOL;
		echo 'hasExpired: ' . ( $accessToken->hasExpired() ? 'expired' : 'not expired' ) . PHP_EOL;

		$resourceOwner = $provider->getResourceOwner($accessToken);

		print_r($resourceOwner);
		echo '</pre>';

	} catch (Exception $e) {
		exit($e->getMessage());

	} catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) {
		exit($e->getMessage());
	}
}

Refresh Token Code Flow

<?php

$provider = new \Liftkeeper\OAuth2\Client\Provider\TSheets([
	'clientId' => '{__TSHEETS-CLIENT-ID__}',
	'clientSecret' => '{__TSHEETS-CLIENT-SECRET__}',
	'redirectUri' => '{__YOUR-CALLBACK-URL__}',
]);

// load stored accessToken
// $accessToken = loadAccessToken();

$newAccessToken = $provider->getAccessToken('refresh_token', [
	'grant_type' => 'refresh_token',
	'access_token' => $accessToken
]);

// save new accessToken
// saveAccessToken($newAccessToken);

License

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