Building a public Shopify application
This tutorial describes how to build a Shopify application in Ruby. The concepts presented here will also apply to developers building applications in other languages such as Python, Node.js and PHP.
After you have generated an API key and password for your public Shopify application you can start the actual development process.
The sample code for this example app can be found in this GitHub repository. The example app showcases how to subscribe to webhook notifications and update product inventory across multiple product variants for a gift basket product.
To follow this tutorial, you will need the following:
Ruby (this example was written with Ruby 2.2.1)
RubyGems, the package management tool for Ruby
Bundler for Ruby, a dependency manager
Download the example code from the GitHub repository
To obtain the necessary dependencies, navigate to the application folder and type
Step 1: Exposing your application to the Internet
Your application is going to be receiving requests from Shopify, so it needs to be exposed to the Internet. The simplest way to achieve this is through a tunneling service such as ngrok, which will allow you to create a secure tunnel from the public Internet to your local machine.
To initialize ngrok, you’ll need to do the following:
- Download ngrok.
- In terminal, navigate to the folder where you downloaded ngrok.
- If you're working on OSX or Linux, start ngrok with
./ngrok http 4567. If you're on Windows, start ngrok with
ngrok http 4567.
This will create a tunnel to your local machine on port 4567, which is the default port for Sinatra applications.
Step 2: Configuring your application
Each time you start ngrok, you’ll be assigned a randomly generated subdomain (e.g. 859998a8.ngrok.io). You will need to configure your application to refer to this address so that Shopify knows where to find your app:
In the sample app code folder, open app.rb and find the
@app_urlparameter so that it matches the subdomain that you’ve been assigned by ngrok. If you're not using ngrok, this parameter should match the URL where your application is deployed.
In the folder containing the project code, create a new file named
.envand open it in a text editor.
This example application uses the
dotenvRuby gem to allow you to pull your
@secretcredentials in from an external file. Your
.envfile is ignored in GitHub by your
.gitignorefile, so your credentials will not be visible to humans.
Log in to your Shopify Partner account.
Click Apps then click the name of your app (or Create app).
Your API Key is displayed, and you can click Show secret beside Credential sets to retrieve your API Secret:
6. Copy the values of the API Key and API Secret from your dashboard, and add them to the
.env file in the following format:
7. Save the
.env file and close it.
Configure App URLs
You will also need to configure your application’s URLs.
Click the name of your app.
Click Edit app settings.
For the Application URL, type
@app_urlis the same value that you defined inside of your
Redirection URL, type
Step 3: Running your app locally
After configuring your app, you can run the example code locally:
Open a new terminal window.
Navigate into the example code folder.
Install your app on a test store
You can also install your app on a test store to test its behavior in the Shopify admin.
Log into your Partner's Dashboard in a new tab.
Click the name of the new app you've created.
Click Edit App Store Listing.
Click View app listing. The listing page for your app loads in the Shopify App Store.
Click Get to install the app to your test store.
Step 4: Building your application
This section of the tutorial will examine the application code contained in
app.rb and explain the rationale for each block of code.
- Authenticating with Shopify
- Creating the webhook subscription
- Receiving the webhook notification
To start, some useful libraries are included for developing your application:
The Shopify API gem allows you to effortlessly make API calls to Shopify. Sinatra is a lightweight web framework for Ruby that you’ll use to quickly develop your web application. You’ll also be using HTTParty to perform HTTP requests. As mentioned previously, the dotenv gem will allow you to load environment variables from an external configuration file.
initialize method for the GiftBasket class:
initializemethod is called every time the application is started.
dotenvgem is invoked in order to import the parameters defined in the
.envfile that you created.
Some instance variables (
@app_url) are defined to store the application's API key and secret key, as well as the base URL of the application.
The empty hash is declared (
@tokens), which will be used to store the access tokens granted to us by Shopify.
In a production environment, you would likely want to use a more permanent method of storage for access tokens such as a relational database.
Sinatra uses routes to invoke a particular method when a client sends an HTTP request to the specified address.
The first route defined in the application,
/giftbasket/install, is used to define the address where the merchant is redirected to when they click Get in the Shopify App Store. This is the address that you defined earlier as the Application URL in the application settings of your partner dashboard.
When the merchant hits this route, you need to redirect them to the application installation screen on Shopify which will look like this:
In the parameters of the
install_url, you need to include the following:
The API key of the application.
Permission scopes required for the application (in this case, the application needs permission to read orders, read products, and write products).
redirect_uriparameter, which is where the merchant will be redirected after they authorize the installation. This should match the URL defined in the partner dashboard as the Redirection URL. In the case, the merchant is redirected to
Authenticating with Shopify
After the merchant has authorized the installation of your application, you’ll need to authenticate with Shopify using the OAuth protocol. If you’re not familiar with OAuth, please see our documentation on OAuth.
Verify the request
The first step is to verify that the request is indeed coming from Shopify. You will be able to verify this by performing HMAC signature validation.
signature parameters are removed from the hash. Next, the keys in the hash are sorted lexicographically, and each key and value pair is joined with an ampersand (‘&’). The resulting string is hashed with the SHA256 algorithm using the application’s secret key as the encryption key. The resulting digest is compared against the
hmac parameter provided in the request. If the comparison is successful, you can be assured that this is a legitimate request from Shopify.
Get an access token
In order to perform Shopify API calls on a particular shop, you'll need an access token belonging to that shop.
To obtain the access token, send a POST request to
shop is the domain of the shop where the application is being installed (e.g. test-shop.myshopify.com). The body of the POST request will contain the API key for the application, the application secret key, as well as the code provided in the original request parameters.
If the request was formed correctly, you should expect to receive a response with status code 200 (OK). This response will contain the access token that you’ll be able to use to instantiate a session with the particular Shopify store that you are trying to access. For the sake of this example, you’ll be storing your access token in a hash where the key is the shop domain.
For the sake of this example, we’ve written our own simple OAuth strategy in order to illustrate the process. If you’re building a Ruby application outside of this example, you should use the omniauth-shopify-oauth2 Ruby gem.
Creating the webhook subscription
After receiving the access token, you can use it to instantiate a session with Shopify. Once the session is active, your application can begin making API calls to Shopify.
This example application application utilizes Webhooks which allow Shopify to communicate with the application when certain shop events are triggered.
In this case, the webhook subscription has the topic
orders/create. This means that Shopify will send a POST request to the specified address every time a new order is created on the merchant's shop.
Receiving and verifying webhooks
When your application receives the POST request to the address you've specified, the first thing you need to do is verify that the request is actually from Shopify and not a potential attacker. The HTTP header of every webhook request sent from Shopify contains a HMAC-SHA256 signature generated using the application’s secret key and the data contained in the body of the request. You will need to generate the same signature and compare it against the header value.
Inside the body of the
verify_webhook helper function, the SHA256 hash is calculated and compared against the header value. A value of
false is returned.
If the comparison was successful, you'll need to extract the shop name from the request header and look up the access token necessary to activate a session with Shopify.
The body of the request will contain the information about the new order in the form of a JSON-encoded Order resource.
Making API calls
When the webhook request is received, the application performs the following actions:
- Inspects the
line_itemsproperty of each order.
- Inspects the
variant_idproperty of each line item and then determines if they contain a
metafieldproperty with the key ingredients.
true, the app considers that product variant to be a gift basket. The value of the metafield contains a comma-separated list of
variant_ids that belong to the gift basket product (created by the merchant).
- Decrements the inventory quantity for each of those product variants.
In a production application you will need to observe the API call limit. We suggest implementing a queueing mechanism for your API calls.
Keep in mind that this tutorial was built solely for the purpose of introducing developers to Shopify's API. If you're building apps in languages other than Ruby, you can apply the same concepts to build your own public Shopify app.
If you're interested in developing a production-quality application for Shopify, you can take a look at one of the following libraries hosted on GitHub:
These libraries contains some useful helper functions for developing your application as well as built-in configuration that makes it easy to deploy your application.
App review process by Shopify
Before you apply to have your app published in the Shopify App store, be sure to follow the guidelines in the app requirements checklist. This is the same checklist that Shopify's Apps team will use when considering publishing your app.