EVE Online Provider for the OAuth 2.0 Client
This package provides EVE Online OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
To install, use composer:
composer require killmails/oauth2-eve
Usage is the same as The League's OAuth client, using \Killmails\OAuth2\Client\Provider\EveOnline as the provider.
$provider = new Killmails\OAuth2\Client\Provider\EveOnline([
'clientId' => '{eve-client-id}',
'clientSecret' => '{eve-client-key}',
'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();
}When creating your EVE Online authorization URL, you can specify the state and scopes your application may authorize.
$options = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['characterFittingsRead','characterFittingsWrite'] // array or string
];
$authorizationUrl = $provider->getAuthorizationUrl($options);If neither are defined, the provider will utilize internal defaults.
At the time of authoring this documentation, the following scopes are available.
- characterContactsRead
- characterContactsWrite
- characterFittingsRead
- characterFittingsWrite
- characterLocationRead
- characterNavigationWrite
- publicData
$ ./vendor/bin/phpunitPlease see CONTRIBUTING for details.
The MIT License (MIT). Please see License File for more information.