https://github.com/mugnate/oauth2-ecwid
Ecwid OAuth 2.0 Client Provider for The PHP League OAuth2-Client
https://github.com/mugnate/oauth2-ecwid
ecwid oauth2
Last synced: about 2 months ago
JSON representation
Ecwid OAuth 2.0 Client Provider for The PHP League OAuth2-Client
- Host: GitHub
- URL: https://github.com/mugnate/oauth2-ecwid
- Owner: mugnate
- License: mit
- Created: 2017-07-12T22:36:02.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-23T08:10:52.000Z (almost 9 years ago)
- Last Synced: 2026-02-20T05:56:53.938Z (3 months ago)
- Topics: ecwid, oauth2
- Language: PHP
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Ecwid Provider for OAuth 2.0 Client
[](https://github.com/mugnate/oauth2-ecwid/releases)
[](LICENSE.md)
[](https://travis-ci.org/mugnate/oauth2-ecwid)
[](https://scrutinizer-ci.com/g/mugnate/oauth2-ecwid)
[](https://packagist.org/packages/mugnate/oauth2-ecwid)
This package provides Ecwid (https://www.ecwid.com/) OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-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
```php
$provider = new Mugnate\OAuth2\Client\Provider\Ecwid([
'clientId' => '{ecwid-client-id}',
'clientSecret' => '{ecwid-client-secret}',
'redirectUri' => 'https://yoursite.com/callback-url',
]);
```
### Link
```php
$authUrl = $provider->getAuthorizationUrl();
$_SESSION['oauth2-ecwid-state'] = $provider->getState();
### Callback
```php
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.
```php
$options = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['read_store_profile', 'read_catalog', 'read_orders'] // array or string
];
$authorizationUrl = $provider->getAuthorizationUrl($options);
```
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/mugnate/oauth2-ecwid/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Nikolay Votintsev](https://github.com/votintsev)
- [All Contributors](https://github.com/mugnate/oauth2-ecwid/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/mugnate/oauth2-ecwid/blob/master/LICENSE) for more information.