Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    passport-shopifypublic

    Passport-Shopify

    NPM Version Build Status Coverage Status

    Passport strategy for authenticating with Shopify using the OAuth 2.0 API.

    This module lets you authenticate using Shopify in your Node.js applications. By plugging into Passport, Shopify authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

    Install

    npm install -S passport-shopify

    Usage

    Configure Strategy

    NOTE: Unlike other OAuth2 passport strategies, this requires a specific shop if you want it to be dynamic.

    The Shopify authentication strategy authenticates users using a Shopify account and OAuth 2.0 tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a client ID, client secret, and callback URL.

    Static Shop Name:

    passport.use(
      new ShopifyStrategy({
        clientID: SHOPIFY_CLIENT_ID,
        clientSecret: SHOPIFY_CLIENT_SECRET,
        callbackURL: "http://127.0.0.1:3000/auth/shopify/callback",
        shop: SHOPIFY_SHOP_SLUG // e.g. my-shop-name.myshopify.com ... the `my-shop-name` part 
      },
      function(accessToken, refreshToken, profile, done) {
        User.findOrCreate({ shopifyId: profile.id }, function (err, user) {
          return done(err, user);
        });
      })
    )

    Dynamic Shop Name:

    See example folder.

    Authenticate Requests

    Use passport.authenticate(), specifying the 'shopify' strategy, to authenticate requests.

    For example, as route middleware in an Express application:

    app.get(
      '/auth/shopify',
      passport.authenticate('shopify', {
        scope: [ 'read_products' ],
        shop: 'storename'
      })
    )
     
    app.get(
      '/auth/shopify/callback',
      passport.authenticate('shopify', { failureRedirect: '/login' }),
      function(req, res) {
        // Successful authentication, redirect home. 
        res.redirect('/')
      }
    )

    Examples

    For a complete, working example, refer to the example.

    Tests

    npm install -d
    npm run test

    Contributors

    License

    The MIT License

    Copyright (c) 2011-2016 Dantheta and Nick Baugh

    install

    npm i passport-shopify

    Downloadslast 7 days

    155

    version

    0.1.2

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar