compwright / oauth2-housecallpro
Housecall Pro OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Fund package maintenance!
compwright
Installs: 5 499
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 6
Open Issues: 0
Requires
- php: ^7.3 || ^8.0
- league/oauth2-client: ^2.5
- psr/http-message: ^1.0 || ^2.0
Requires (Dev)
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9.5
- psr/http-message: ^1.1
- squizlabs/php_codesniffer: ^3.6
This package is auto-updated.
Last update: 2024-12-03 18:58:35 UTC
README
This package provides Housecall Pro OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require compwright/oauth2-housecallpro league/oauth2-client
Usage
Usage is the same as The League's OAuth client, using \Compwright\OAuth2_Housecallpro\Provider
as the provider.
Example: Authorization Code Flow
$provider = new Compwright\OAuth2_Housecallpro\Provider([ 'clientId' => '{housecallpro-client-id}', 'clientSecret' => '{housecallpro-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'] ]); // 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
$ composer run-script test
Contributing
Please see CONTRIBUTING for details.
Credits
- Jonathon Hill
- Steven Maguire for the Box provider package, which this package is forked form
- All Contributors
License
The MIT License (MIT). Please see License File for more information.