evelabs/oauth2-eveonline

EvE Online OAuth 2.0 Client Provider for The PHP League OAuth2-Client

EVE Online Provider for OAuth 2.0 Client

, _(*1)

This package provides Eve Online OAuth 2.0 support for the PHP League's OAuth 2.0 Client., _(*2)

Installation

To install, use composer:, _(*3)

composer require evelabs/oauth2-eveonline

Docs

Eve Online CREST&SSO 3rd party documentation, _(*4)

Usage

Usage is the same as The League's OAuth client, using \Evelabs\OAuth2\Client\Provider\EveOnline as the provider., _(*5)

See example/example.php for more insight., _(*6)

Authorization Code Flow

$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();
}

Managing Scopes

When creating your EveOnline authorization URL, you can specify the scopes your application may authorize., _(*7)

$options = [
    'scope' => ['publicData','characterLocationRead'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

Refreshing access token

EVE Online Oauth server issues short-lived(around 20 minutes) access tokens so once it expires you have to obtain a new one using long-lived refresh token., _(*8)

$new_token = $provider->getAccessToken('refresh_token', [
    'refresh_token' => $old_token->getRefreshToken()
]);

Calling CREST

Once you've obtained both (access & refresh) tokens you can start making requests., _(*9)

Example GET

$request = $provider->getAuthenticatedRequest(
    'GET',
    'https://crest-tq.eveonline.com/characters/{characterID}/',
    $accessToken->getToken()
);

$response = $provider->getResponse($request);

Example POST

$request = $provider->getAuthenticatedRequest(
    'POST',
    'https://crest-tq.eveonline.com/characters/{characterID}/',
    $accessToken->getToken(),
    ['body' => 'some stuff']
);

$response = $provider->getResponse($request);

Framework integration

Symfony 2, _(*10)

• KnpUOAuth2ClientBundle

Testing

bash $ ./vendor/bin/phpunit, _(*11)

Contributing

Please see CONTRIBUTING for details., _(*12)

Credits

• Oleg Krasavin
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*13)