phpnexus/oauth2-freee

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

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

Requires

• league/oauth2-client: ^2.7

Requires (Dev)

• mockery/mockery: ^1.6
• phpunit/phpunit: ^9.6
• squizlabs/php_codesniffer: ^3.7

MIT

• Mark Prosser

• authorization
• client
• oauth
• oauth2
• authorisation
• freee

README

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

• Mark Prosser
• All Contributors

License

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