sportily/sportily-laravel-oauth-client

为Laravel框架提供的OAuth客户端库

dev-master 2020-09-02 06:59 UTC

This package is auto-updated.

Last update: 2024-08-29 04:09:10 UTC


README

这是一个针对Laravel框架的OAuth 2.0客户端库,用于将您的应用程序与Sportily联赛管理系统服务集成。

安装

Composer是安装此包的推荐方式。将以下行添加到您的composer.json文件中

"sportily/sportily-laravel-oauth-client": "dev-master@dev"

然后运行composer update以获取此包。

一旦Composer安装了此包,请将以下行添加到位于您的config/app.php文件中的providers数组中

Sportily\OAuth\OAuthServiceProvider::class,

将此行添加到aliases数组中

'OAuth' => Sportily\OAuth\Facades\OAuth::class,

将以下行添加到位于您的app/Http/Kernel.php文件中的$routeMiddleware数组中

'auth.sportily.private' => \Sportily\OAuth\Middleware\OAuthMiddlewarePrivate::class,
'auth.sportily.public' => \Sportily\OAuth\Middleware\OAuthMiddlewarePublic::class,

接下来,运行php artisan vendor:publish来发布此包的配置。您不需要直接编辑配置文件。相反,将以下行添加到您的.env文件中

SPORTILY_OAUTH_REDIRECT_URL=http://<your-domain>/callback
SPORTILY_OAUTH_CLIENT_ID=<your-public-key>
SPORTILY_OAUTH_CLIENT_SECRET=<your-secret-key>

中间件

此包提供中间件,可处理获取和刷新访问令牌的复杂性。访问令牌是调用Sportily API服务所必需的。

访问公开数据

API公开的数据大多为公开数据,例如赛程、场馆、联赛统计数据等。

如果您只想从API中检索公开数据,则只需使用auth.sportily.public中间件装饰您的路由即可。

此中间件确保会话中始终存在有效的访问令牌。

访问私有数据

如果您需要访问私有数据,您必须要求用户先登录,授予对该用户有访问权限的所有内容。

在这种情况下,您应使用auth.sportily.private中间件装饰您的路由。

如果用户尚未登录,此中间件将重定向用户到登录提示。如果用户登录并授予您的应用程序访问权限,则会在会话中添加一个访问令牌,该令牌授予您的应用程序访问所有用户私有数据的权限。

下一步

使用Sportily API客户端库向API发出请求。