helpscout / oauth2-hubspot
HubSpot OAuth 2 Client Provider for The PHP League OAuth2-Client package
Installs: 149 984
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 32
Forks: 1
Open Issues: 2
Requires
- league/oauth2-client: ^2.0
Requires (Dev)
- phpunit/phpunit: ^9.0
This package is not auto-updated.
Last update: 2024-12-23 23:22:47 UTC
README
This package provides a HubSpot OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
To install, use composer:
composer require helpscout/oauth2-hubspot
Usage
Usage is the same as The League's OAuth client, using \HelpScout\OAuth2\Client\Provider\HubSpot
as the provider.
Authorization Code Flow
$provider = new HelpScout\OAuth2\Client\Provider\HubSpot([ 'clientId' => '{hubspot-client-id}', 'clientSecret' => '{hubspot-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]);
For further usage of this package please refer to the core package documentation on "Authorization Code Grant".
Refreshing a Token
$provider = new HelpScout\OAuth2\Client\Provider\HubSpot([ 'clientId' => '{hubspot-client-id}', 'clientSecret' => '{hubspot-client-secret}', 'redirectUri' => 'https://example.com/callback-url' ]); $existingAccessToken = getAccessTokenFromYourDataStore(); if ($existingAccessToken->hasExpired()) { $newAccessToken = $provider->getAccessToken('refresh_token', [ 'refresh_token' => $existingAccessToken->getRefreshToken() ]); // Purge old access token and store new access token to your data store. }
For further usage of this package please refer to the core package documentation on "Refreshing a Token".
Testing
$ ./vendor/bin/phpunit
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.