Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 3.15 KB

README.md

File metadata and controls

104 lines (69 loc) · 3.15 KB
Raw

TD Ameritrade Provider for OAuth 2.0 Client

This package provides TD Ameritrade OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Build Status Codacy Badge Codacy Badge

Installation

To install, use composer:

composer require lupecode/oauth2-tdameritrade

Usage

Usage is the same as The League's OAuth client, using \LupeCode\OAuth2\Client\Provider\TDAmeritrade as the provider.

Authorization Code Flow

$provider = new LupeCode\OAuth2\Client\Provider\TDAmeritrade([
    'clientId'          => '{tdameritrade-client-id}',
    '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);

    } 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 TD Ameritrade authorization URL, you can specify the state and scopes your application may authorize.

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => [] // array or string
    // note that TD Ameritrade is still developing their API,
    // and the scopes do not work correctly at the moment.
];

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

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, no scopes are required.

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.