Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multidimension-al/oauth2-shopify
This package provides Shopify's OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
https://github.com/multidimension-al/oauth2-shopify
Last synced: 15 days ago
JSON representation
This package provides Shopify's OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
- Host: GitHub
- URL: https://github.com/multidimension-al/oauth2-shopify
- Owner: multidimension-al
- License: mit
- Created: 2016-12-12T17:25:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-23T22:04:05.000Z (about 7 years ago)
- Last Synced: 2024-04-25T07:41:56.208Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 18.6 KB
- Stars: 10
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shopify - multidimension-al/oauth2-shopify - Shopify's OAuth 2.0 support for the PHP League's OAuth 2.0 Client. (Libraries / PHP)
README
# Shopify Provider for OAuth 2.0 Client
[](https://packagist.org/packages/multidimensional/oauth2-shopify)
[](https://packagist.org/packages/multidimensional/oauth2-shopify)
[](https://packagist.org/packages/multidimensional/oauth2-shopify)
[](https://travis-ci.org/multidimension-al/oauth2-shopify)
[](https://scrutinizer-ci.com/g/multidimension-al/oauth2-shopify/?branch=master)
This package provides Shopify's 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 multidimensional/oauth2-shopify
```
### Usage
Usage is the same as The League's OAuth client, using `\Multidimensional\OAuth2\Client\Provider\Shopify` as the provider.
### Authorization Code Flow
```php
$provider = new Multidimensional\OAuth2\Client\Provider\Shopify([
'clientId' => '{shopify-app-id}',
'clientSecret' => '{shopify-app-secret}',
'shop' => 'example.myshopify.com',
'redirectUri' => 'https://example.com/callback-url',
]);
if (!isset($_GET['code'])) {
$options = [
'scope' => ['read_orders','write_orders'] // array or string
];
// If we don't have an authorization code then get one
$authUrl = $provider->getAuthorizationUrl($options);
$_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->getName());
} 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 Shopify authorization URL, you can specify the state and scopes your application may authorize.
```php
$options = [
'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
'scope' => ['read_orders','write_orders'] // 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](https://help.shopify.com/api/guides/authentication/oauth#scopes).
- read_content, write_content- Access to Article, Blog, Comment, Page, and Redirect.
- read_themes, write_themes - Access to Asset and Theme.
- read_products, write_products - Access to Product, product variant, Product Image, Collect, Custom Collection, and Smart Collection.
- read_customers, write_customers - Access to Customer and Saved Search.
- read_orders, write_orders - Access to Order, Transaction and Fulfillment.
- read_script_tags, write_script_tags - Access to Script Tag.
- read_fulfillments, write_fulfillments - Access to Fulfillment Service.
- read_shipping, write_shipping - Access to Carrier Service.
- read_analytics - Access to Analytics API.
- read_users, write_users - Access to User SHOPIFY PLUS.
## Testing
``` bash
$ ./vendor/bin/phpunit
```
## Contributing
Please see [CONTRIBUTING](https://github.com/multidimension-al/oauth2-shopify/blob/master/CONTRIBUTING.md) for details.
## Credits
- [Nile Suan](https://github.com/nilesuan)
- [All Contributors](https://github.com/multidimension-al/oauth2-shopify/contributors)
## License
The MIT License (MIT). Please see [License File](https://github.com/multidimension-al/oauth2-shopify/blob/master/LICENSE) for more information.