flipboxdigital / oauth2-hubspot
The PHP League OAuth2-Client 的 HubSpot OAuth 2.0 客户端提供者
1.0.1
2018-07-09 15:15 UTC
Requires
- league/oauth2-client: ^2.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-09-09 14:03:52 UTC
README
本软件包为 PHP League 的 OAuth 2.0 客户端提供 HubSpot OAuth 2.0 支持。
安装
要安装,请使用 composer
composer require flipboxdigital/oauth2-hubspot
用法
用法与 The League 的 OAuth 客户端相同,使用 \Flipbox\OAuth2\Client\Provider\HubSpot
作为提供者。
授权码流
$provider = new Flipbox\OAuth2\Client\Provider\HubSpot([ 'clientId' => '{hubspot-client-id}', 'clientSecret' => '{hubspot-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 } 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 $user = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $user->getEmail()); } catch (Exception $e) { // Failed to get user details exit('Oh dear...'); } // Use this to interact with an API on the users behalf echo $token->getToken(); }
管理作用域
当创建您的 HubSpot 授权 URL 时,您可以指定您的应用程序可以授权的状态和作用域。
$options = [ 'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE', 'scope' => ['contacts','content'] // array or string ]; $authorizationUrl = $provider->getAuthorizationUrl($options);
如果两者都没有定义,则提供者将使用内部默认值。
在编写此文档时,以下作用域可用:
- contacts
- content
- reports
- social
- automation
- timeline
- forms
- files
- hubdb
- transactional-email
测试
$ ./vendor/bin/phpunit
贡献
有关详细信息,请参阅 CONTRIBUTING
鸣谢
许可协议
MIT 许可协议(MIT)。有关更多信息,请参阅 许可文件