evolic / oauth2-eveonline
为PHP League的OAuth2-Client提供的EvE Online OAuth 2.0客户端提供程序
2.0.1
2020-08-06 12:03 UTC
Requires
- php: >=5.5.0
- league/oauth2-client: ^2.0
Requires (Dev)
- mockery/mockery: ~0.9
- phpunit/phpunit: ~4.0
- squizlabs/php_codesniffer: ~2.0
This package is auto-updated.
Last update: 2024-09-06 21:54:36 UTC
README
此包为PHP League的OAuth 2.0客户端提供EvE Online OAuth 2.0支持。
安装
要安装,请使用composer
composer require evelabs/oauth2-eveonline
文档
用法
用法与The League的OAuth客户端相同,使用\Evelabs\OAuth2\Client\Provider\EveOnline
作为提供者。
请参阅example/example.php
以获取更多信息。
授权码流
$provider = new Evelabs\OAuth2\Client\Provider\EveOnline([ 'clientId' => '{eveonline-client-id}', 'clientSecret' => '{eveonline-client-secret}', 'redirectUri' => 'https://example.com/callback-url', ]); if (!isset($_GET['code'])) { // If we don't have an authorization code then get one $authUrl = $provider->getAuthorizationUrl(); $_SESSION['oauth2state'] = $provider->getState(); header('Location: '.$authUrl); exit; // Check given state against previously stored one to mitigate CSRF attack } elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) { unset($_SESSION['oauth2state']); exit('Invalid state'); } else { // Try to get an access token (using the authorization code grant) $token = $provider->getAccessToken('authorization_code', [ 'code' => $_GET['code'] ]); // Optional: Now you have a token you can look up a users profile data try { // We got an access token, let's now get the user's details $user = $provider->getResourceOwner($token); // Use these details to create a new profile printf('Hello %s!', $user->getCharacterName()); } catch (Exception $e) { // Failed to get user details exit('Oh dear...'); } // Use this to interact with an API on the users behalf echo $token->getToken(); }
管理作用域
在创建您的EvE Online授权URL时,您可以指定应用程序可能授权的作用域。
$options = [ 'scope' => ['publicData','characterLocationRead'] // array or string ]; $authorizationUrl = $provider->getAuthorizationUrl($options);
刷新访问令牌
EVE Online Oauth服务器发放短时效(大约20分钟)的访问令牌,因此一旦过期,您必须使用长期刷新令牌获取新的访问令牌。
$new_token = $provider->getAccessToken('refresh_token', [ 'refresh_token' => $old_token->getRefreshToken() ]);
调用CREST
一旦您获得了(访问和刷新)令牌,您就可以开始发送请求。
示例GET请求
$request = $provider->getAuthenticatedRequest( 'GET', 'https://crest-tq.eveonline.com/characters/{characterID}/', $accessToken->getToken() ); $response = $provider->getResponse($request);
示例POST请求
$request = $provider->getAuthenticatedRequest( 'POST', 'https://crest-tq.eveonline.com/characters/{characterID}/', $accessToken->getToken(), ['body' => 'some stuff'] ); $response = $provider->getResponse($request);
框架集成
Symfony 2
测试
$ ./vendor/bin/phpunit
贡献
请参阅贡献指南以获取详细信息。
鸣谢
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。