README

本软件包为 PHP League 的 OAuth 2.0 客户端 提供Shopify的OAuth 2.0支持。

安装

要安装，请使用 composer

composer require chadhutchins/oauth2-shopify

使用方法

使用方法与 The League 的 OAuth 客户端相同，使用 \Chadhutchins\OAuth2\Client\Provider\Shopify 作为提供者。

授权码流程

$provider = new Chadhutchins\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();
}

管理作用域

在创建您的 Shopify 授权 URL 时，您可以指定应用程序可以授权的状态和作用域。

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

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

如果两者都没有定义，提供者将使用内部默认值。

在编写此文档时，以下作用域可用：

• read_content, write_content- 访问文章、博客、评论、页面和重定向。
• read_themes, write_themes - 访问资产和主题。
• read_products, write_products - 访问产品、产品变体、产品图片、收藏、自定义收藏和智能收藏。
• read_customers, write_customers - 访问客户和保存的搜索。
• read_orders, write_orders - 访问订单、交易和履行。
• read_script_tags, write_script_tags - 访问脚本标签。
• read_fulfillments, write_fulfillments - 访问履行服务。
• read_shipping, write_shipping - 访问承运服务。
• read_analytics - 访问分析 API。
• read_users, write_users - 访问用户 SHOPIFY PLUS。

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅 CONTRIBUTING。

致谢

• Nile Suan
• 所有贡献者

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 了解更多信息。