README

此包为 PHP League 的 OAuth 2.0 客户端 提供Housecall Pro OAuth 2.0 支持。

安装

要安装，请使用 composer

composer require compwright/oauth2-housecallpro league/oauth2-client

用法

用法与 The League 的 OAuth 客户端相同，使用 \Compwright\OAuth2_Housecallpro\Provider 作为提供者。

示例：授权代码流程

$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();

测试

$ composer run-script test

贡献

请参阅 CONTRIBUTING 以获取详细信息。

鸣谢

• Jonathon Hill
• Steven Maguire 为 Box 提供程序包，本程序包由此分支而来
• 所有贡献者

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅 许可证文件。