Skip to content

Latest commit

 

History

History
143 lines (78 loc) · 5.54 KB

README.rdoc

File metadata and controls

143 lines (78 loc) · 5.54 KB
Raw

Shopify API ↑

The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.

The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.

Usage ↑

Requirements ↑

All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:

For more information and detailed documentation about the API visit api.shopify.com

Installation ↑

To easily install or upgrade to the latest release, use gem

gem install shopify_api

Getting Started ↑

ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:

  1. First create a new application in either the partners admin or your store admin. For a private App you’ll need the API_KEY and the PASSWORD otherwise you’ll need the API_KEY and SHARED_SECRET.

  2. For a private App you just need to set the base site url as follows (where hostname is your site)

    shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.myshopify.com/admin"
ShopifyAPI::Base.site = shop_url

    That’s it you’re done, skip to step 7 and start using the API!

    For a partner app you will need to supply two parameters to the Session class before you instantiate it:

    ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})

  3. To access a shop’s data apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:

    GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize

    with the following parameters:

    • client_id – Required – The API key for your app

    • scope – Required – The list of required scopes (explained here: docs.shopify.com/api/tutorials/oauth)

    • redirect_uri – Optional – The URL that the merchant will be sent to once authentication is complete. Must be the same host as the Return URL specified in the application settings

    We’ve added the create_permision_url method to make this easier:

    permission_url = ShopifyAPI::Session.create_permission_url("SHOP_NAME.myshopify.com", scope=["write_products"], redirect_uri=nil)

  4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named ‘code’. This is a temporary token that the app can exchange for a permanent access token. Make the following call:

    POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token

    with the following parameters:

    • client_id – Required – The API key for your app

    • client_secret – Required – The shared secret for your app

    • code – Required – The token you received in step 3

    and you’ll get your permanent access token back in the response.

    There is also a method to create this url for you:

    auth_url = ShopifyAPI::Session.create_auth_url("SHOP_NAME.myshopify.com", code)

  5. Use that token to instantiate a session that is ready to make calls to the given shop.

    session = ShopifyAPI::Session.new("SHOP_NAME.myshopify.com", token)
session.valid?  # returns true

  6. Now you can activate the session and you’re set:

    ShopifyAPI::Base.activate_session(session)

  7. Start making authorized API requests for that shop. Data is returned as ActiveResource instances:

    shop = ShopifyAPI::Shop.current

# Get a specific product
product = ShopifyAPI::Product.find(179761209)

# Create a new product
new_product = ShopifyAPI::Product.new
new_product.title = "Burton Custom Freestlye 151"
new_product.product_type = "Snowboard"
new_product.vendor = "Burton"
new_product.save

# Update a product
product.handle = "burton-snowboard"
product.save

    Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:

    products = ShopifyAPI::Session.temp("SHOP_NAME.myshopify.com", token) { ShopifyAPI::Product.find(:all) }

  8. Finally, you can also clear the session (for example if you want to work with another shop):

    ShopifyAPI::Base.clear_session

Console ↑

This package also includes the ‘shopify` executable to make it easy to open up an interactive console to use the API with a shop.

  1. Obtain a private API key and password to use with your shop (step 2 in “Getting Started”)

  2. Use the ‘shopify` script to save the credentials for the shop to quickly login.

    shopify add yourshopname

    Follow the prompts for the shop domain, API key and password.

  3. Start the console for the connection.

    shopify console

  4. Enter the following for the full list of the commands.

    shopify help

Using Development Version ↑

Download the source code and run:

rake install

Additional Resources ↑

api.shopify.com <= Read the tech docs!

ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions on the forums!

Copyright ↑

Copyright © 2012 “Shopify inc.”. See LICENSE for details.