phpnexus/oauth2-freee

Freee OAuth 2.0 support for the PHP League's OAuth 2.0 Client

Maintainers

Details

github.com/phpnexus/oauth2-freee

Source

Issues

Installs: 12

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

dev-main 2024-02-06 09:53 UTC

Requires

Requires (Dev)

MIT d3be1600b30cb0ac68a80ffd2521f0383cbf1ef2

  • Mark Prosser

authorizationclientoauthoauth2authorisationfreee

This package is auto-updated.

Last update: 2024-11-25 05:34:56 UTC

README

Actions Status Coverage Status License Version Downloads

This package provides Freee OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require phpnexus/oauth2-freee

Usage

Usage is the same as The League's OAuth client, using \PhpNexus\OAuth2\Client\Provider\Freee as the provider.

Authorization Code Flow

$provider = new PhpNexus\OAuth2\Client\Provider\Freee([
    'clientId'          => '{freee-app-client-id}',
    'clientSecret'      => '{freee-app-client-secret}',
    'redirectUri'       => 'https://example.com/redirect-url'
]);

For further usage of this package please refer to the core package documentation on "Authorization Code Grant".

Refreshing a Token

Once your application is authorized, you can refresh an expired token using a refresh token rather than going through the entire process of obtaining a brand new token. To do so, simply reuse this refresh token from your data store to request a refresh.

$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.