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\HousecallproProvider as the provider.

Example: Authorization Code Flow

$factory = new CompWright\OAuth2\HousecallPro\HousecallproProviderFactory();

$provider = $factory->new(
    clientId: '{housecallpro-client-id}',
    clientSecret: '{housecallpro-client-secret}',
    redirectUri: '{housecallpro-app-redirect-uri}',
);

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

$ make test

Contributing

Please see CONTRIBUTING for details.

License

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

compwright / oauth2-housecallpro

Maintainers

Details