Ecwid OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Provider
tests/src/Provider
.gitignore
.scrutinizer.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
composer.json
phpunit.xml

README.md

Ecwid Provider for OAuth 2.0 Client

Latest Version Software License Build Status Quality Score Total Downloads

This package provides Ecwid (https://www.ecwid.com/) OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require mugnate/oauth2-ecwid

Usage

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

Configuration

$provider = new Mugnate\OAuth2\Client\Provider\Ecwid([
    'clientId'          => '{ecwid-client-id}',
    'clientSecret'      => '{ecwid-client-secret}',
    'redirectUri'       => 'https://yoursite.com/callback-url',
]);

Link

$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2-ecwid-state'] = $provider->getState();

echo '<a href="' .$authUrl. '"></a>';

Callback

if (! isset($_GET['code'])) {
    exit('Invalid code');
}
// Check given state against previously stored one to mitigate CSRF attack
elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2-ecwid-state'])) {

    unset($_SESSION['oauth2-ecwid-state']);
    exit('Invalid state');

} else {

    try {

        // Try to get an access token (using the authorization code grant)
        $token = $provider->getAccessToken('authorization_code', [
            'code' => $_GET['code']
        ]);

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');
    }

    // 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('Your email %s!', $user->getEmail());

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['read_store_profile', 'read_catalog', 'read_orders'] // array or string
];

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

Testing

$ ./vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

License

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