Skip to content

Latest commit

 

History

History
140 lines (94 loc) · 7.48 KB

README.md

File metadata and controls

140 lines (94 loc) · 7.48 KB
Raw

Shopify API Library for Ruby

License: MIT Build Status

This library provides support for Ruby Shopify apps to access the Shopify Admin API, by making it easier to perform the following actions:

  • Creating online or offline access tokens for the Admin API via OAuth
  • Making requests to the REST API
  • Making requests to the GraphQL API
  • Registering/processing webhooks

In addition to the Admin API, this library also allows querying the Storefront API.

You can use this library in any application that has a Ruby backend, since it doesn't rely on any specific framework — you can include it alongside your preferred stack and use the features that you need to build your app.

Note: These instructions apply to v10 or later of this package. If you're running v9 in your app, you can find the documentation in this branch.

Requirements

To follow these usage guides, you will need to:

  • have a working knowledge of ruby and a web framework such as Rails or Sinatra
  • have a Shopify Partner account and development store
  • OR have a test store where you can create a private app
  • have an app already set up in your test store or partner account
  • use ngrok to create a secure tunnel to your app running on your localhost
  • add the ngrok URL and the appropriate redirect for your OAuth callback route to your app settings

Installation

Add the following to your Gemfile:

gem "shopify_api"

or use bundler:

bundle add shopify_api

Steps to use the Gem

Setup Shopify Context

Start by initializing the NewShopifyAPI::Context with the parameters of your app by calling NewShopifyAPI::Context.setup (example below) when your app starts (e.g application.rb in a Rails app).

NewShopifyAPI::Context.setup(
  api_key: "<api-key>",
  api_secret_key: "<api-secret-key>",
  host_name: "<application-host-name>",
  scope: "read_orders,read_products,etc",
  session_storage: NewShopifyAPI::Auth::FileSessionStorage.new, # See more details below
  is_embedded: true, # Set to true if you are building an embedded app
  is_private: false, # Set to true if you are building a private app
  api_version: "2022-01" # The version of the API you would like to use
)

Setup a Session Store

In order for the Shopify API gem to properly store sessions it needs an implementation of NewShopifyAPI::Auth::SessionStorage. We provide one implementation in the gem, NewShopifyAPI::Auth::FileSessionStorage, which is suitable for testing/development, but isn't intended for production apps. See the Session Storage doc for instructions on how to create a custom session store for a production application.

Session information would is typically stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that the library can use to store and retrieve a session given its ID. In a non-embedded app this ID will come from a cookie, whereas in an embedded app this ID will come from App Bridge.

Performing OAuth

Next, unless you are making a private app, you need to go through OAuth as described here to create sessions for shops using your app. The Shopify API gem tries to make this easy by providing functions to begin and complete the OAuth process. See the Oauth doc for instructions on how to use these.

Register Webhooks and a Webhook Handler

If you intend to use webhooks in your application follow the steps in the Webhooks doc for instructions on registering and handling webhooks.

Start Making Authenticated Shopify Requests

Once your app can perform OAuth, it can now make authenticated Shopify API calls using the Admin REST or GraphQL Clients, or the Storefront API GraphQL Client.

Breaking Change Notices

Breaking change notice for version 10.0.0

We've rewritten this library for v10, so that it provides all essential features for a Shopify app without requiring any other packages.

Here are the main features it provides:

  • OAuth support, both with online and offline tokens.
  • Full, transparent support for JWT sessions for embedded apps and cookies for non-embedded ones.
    • Removal of support for 3rd party cookies which are increasingly more difficult to use with modern browsers.
  • Admin API support
    • Auto-generated, version-specific REST resources which are similar to ActiveResource (though not identical), that provide methods for all endpoints defined in our REST API reference, as well as direct definition of known attributes.
    • A GraphQL client that doesn't rely on the ActiveResource implementation for REST.
  • Webhook management, with features for adding handlers and registering them with Shopify.
  • Storefront GraphQL API support

Please refer to the documentation in this repository for instructions on how to use each of these components.

With this, a lot changed in how apps access the library. Here are the updates you should make when migrating to v10:

  • Call NewShopifyAPI::Context.setup when setting up your app. This class holds global configurations for your app and defines how the library behaves.

  • If not using the shopify_app gem, your app needs to provide an implementation of NewShopifyAPI::Auth::SessionStorage for production. Read more about this in our documentation.

  • To change the User-Agent header, use user_agent_prefix in NewShopifyAPI::Context.setup.

  • Usages of the ActiveResource classes for REST API requests need to be refactored into the new format. You can find detailed examples on how each of the endpoints work in our reference documentation.

    Please see below a (non-exhaustive) list of common replacements to guide you in your updates, using the Order resource as an example.

    Before After
    Order.find(:all, params: {param1: value1}) Order.all(param1: value1, session:)
    Order.find(<id>) Order.find(id: <id>, session:)
    order = Order.new(<id>)
    order.post(:close)    		 order = Order.new(session:)
    order.close()
    order = Order.new(<id>)
    order.delete    		 Order.delete(id: <id>, session:)

Breaking changes for older versions

See BREAKING_CHANGES_FOR_OLDER_VERSIONS

Developing this gem

After cloning the repository, you can install the dependencies with bundler:

bundle install

To run the automated tests:

bundle exec rake test

We use rubocop to lint/format the code. You can run it with the following command:

bundle exec rubocop