phpnexus/oauth2-freee

为 PHP League 的 OAuth 2.0 客户端提供 Freee OAuth 2.0 支持

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

This package is auto-updated.

Last update: 2024-08-25 04:57:41 UTC


README

Actions Status Coverage Status License Version Downloads

本包为 PHP League 的 OAuth 2.0 客户端 提供了 Freee OAuth 2.0 支持。

安装

要安装,请使用 composer

composer require phpnexus/oauth2-freee

用法

用法与 The League 的 OAuth 客户端相同,使用 \PhpNexus\OAuth2\Client\Provider\Freee 作为提供者。

授权码流

$provider = new PhpNexus\OAuth2\Client\Provider\Freee([
    'clientId'          => '{freee-app-client-id}',
    'clientSecret'      => '{freee-app-client-secret}',
    'redirectUri'       => 'https://example.com/redirect-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.
}

有关本包的进一步使用,请参阅 核心包文档中的“刷新令牌”

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息,请参阅 CONTRIBUTING

致谢

许可

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