omniauth-shopify-oauth2, OmniAuth 1.0的Shopify OAuth2策略

分享于 

4分钟阅读

GitHub

  繁體 雙語
Shopify OAuth2 Strategy for OmniAuth 1.0
  • 源代码名称:omniauth-shopify-oauth2
  • 源代码网址:http://www.github.com/Shopify/omniauth-shopify-oauth2
  • omniauth-shopify-oauth2源代码文档
  • omniauth-shopify-oauth2源代码下载
  • Git URL:
    git://www.github.com/Shopify/omniauth-shopify-oauth2.git
    Git Clone代码到本地:
    git clone http://www.github.com/Shopify/omniauth-shopify-oauth2
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/Shopify/omniauth-shopify-oauth2
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    

    Build Status

    OmniAuth Shopify

    OmniAuth 1.0的Shopify OAuth2策略。

    安装

    添加到你的Gemfile:

    gem 'omniauth-shopify-oauth2'

    然后 bundle install

    用法

    OmniAuth::Strategies::Shopify 只是一个 rack 中间件。 阅读 OmniAuth 1.0文档详细说明。

    下面是一个快速示例,将中间件添加到 config/initializers/omniauth.rb 中的Rails 应用程序:

    Rails.application.config.middleware.use OmniAuth::Builderdo provider :shopify, ENV['SHOPIFY_API_KEY'], ENV['SHOPIFY_SHARED_SECRET']end

    通过 Having 认证用户访问/auth/shopify 使用他们的商店域 myshopify.com的shop 查询参数。 例如可以使用以下表单

    <formaction="/auth/shopify"method="get">
     <labelfor="shop">Enter your store's URL:</label>
     <inputtype="text"name="shop"placeholder="your-shop-url.myshopify.com">
     <buttontype="submit">Log In</button>
    </form>

    配置

    你可以配置作用域,通过 Hash 将传入的范围传递给 provider 方法:

    • scope: 要从用户处请求的逗号分隔的权限列表。 有关可用权限的完整列表,请参见的Shopify API文档。

    例如要请求 read_productsread_orderswrite_content 权限并显示身份验证页面:

    Rails.application.config.middleware.use OmniAuth::Builderdo provider :shopify, ENV['SHOPIFY_API_KEY'], ENV['SHOPIFY_SHARED_SECRET'], :scope => 'read_products,read_orders,write_content'end

    身份验证哈希

    下面是 request.env['omniauth.auth'] 中提供的身份验证哈希示例:

    {
     :provider => 'shopify',
     :uid => 'example.myshopify.com',
     :credentials => {
     :token => 'afasd923kjh0934kf', # OAuth 2.0 access_token, which you store and use to authenticate API requests }
    }

    许可证

    版权所有( c ) 2012 Shopify公司

    若要在取得该软件副本时免费授予任何人,如有下列条件的软件,请免费授予该软件的副本,并与相关的文档文件("软件") 进行许可,包括不受限制的权利,包括以下条件:

    上述版权声明和本许可声明须包括在所有的副本或实质性部分的软件。

    软件是"是",没有任何保证,表示或者隐含,包括但不限于销售,适合特定用途和 NONINFRINGEMENT。 作者或者版权持有人在合同。侵权或者它的他与软件或者它的他用户交易的行为。


    str  Oauth  SHOP  strategy  Shopify  Omniauth  
    相关文章