Skip to content

Latest commit

 

History

History
200 lines (133 loc) · 8.37 KB

README.md

File metadata and controls

200 lines (133 loc) · 8.37 KB
Raw

Spiffy Stores API

Build Status

The SpiffyStores API gem allows Ruby developers to programmatically access the admin section of SpiffyStores 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 SpiffyStores applications.

For more information and detailed documentation about the API visit https://www.spiffystores.com.au/kb/An_Introduction_to_the_Spiffy_Stores_API

Ruby version

This gem requires Ruby 2.4.3 as of version 4.11.0.

Installation

Add spiffy_stores_api to your Gemfile:

gem 'spiffy_stores_api'

Or install via gem

gem install spiffy_stores_api

Getting Started

SpiffyStoresAPI 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.

    If you're not sure how to create a new application in the partner/store admin and/or if you're not sure how to generate the required credentials, you can read the related spiffy_stores docs on the same.

  2. For a private App you just need to set the base site url as follows:

    shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.spiffystores.com/api"
SpiffyStoresAPI::Base.site = shop_url

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

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

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

Spiffy Stores maintains omniauth-spiffy-oauth2 which securely wraps the OAuth flow and interactions with Spiffy Stores (steps 3 and 4 above). Using this gem is the recommended way to use OAuth authentication in your application.

  1. In order 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.spiffystores.com/api/oauth/authorize

    with the following parameters:

    • client_id– Required – The API key for your app
    • scope – Required – The list of required scopes (explained here: http://docs.spiffy_stores.com/api/tutorials/oauth)
    • redirect_uri – Required – The URL where you want to redirect the users after they authorize the client. The complete URL specified here must be identical to one of the Application Redirect URLs set in the App's section of the Partners dashboard. Note: in older applications, this parameter was optional, and redirected to the Application Callback URL when no other value was specified.
    • state – Optional – A randomly selected value provided by your application, which is unique for each authorization request. During the OAuth callback phase, your application must check that this value matches the one you provided during authorization. This mechanism is important for the security of your application.

    We've added the create_permission_url method to make this easier, first instantiate your session object:

    session = SpiffyStoresAPI::Session.new("SHOP_NAME.spiffystores.com")

    Then call:

    scope = ["write_products"]
permission_url = session.create_permission_url(scope)

    or if you want a custom redirect_uri:

    permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")

  2. 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.

    Before you proceed, make sure your application performs the following security checks. If any of the checks fails, your application must reject the request with an error, and must not proceed further.

    • Ensure the provided state is the same one that your application provided to SpiffyStores during Step 3.
    • Ensure the provided hmac is valid. The hmac is signed by SpiffyStores as explained below, in the Verification section.
    • Ensure the provided hostname parameter is a valid hostname, ends with myspiffy_stores.com, and does not contain characters other than letters (a-z), numbers (0-9), dots, and hyphens.

    If all security checks pass, the authorization code can be exchanged once for a permanent access token. The exchange is made with a request to the shop.

    POST https://SHOP_NAME.spiffystores.com/api/oauth/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 a method to make the request and get the token for you. Pass all the params received from the previous call and the method will verify the params, extract the temp code and then request your token:

    token = session.request_token(params)

    This method will save the token to the session object and return it. For future sessions simply pass the token in when creating the session object:

    session = SpiffyStoresAPI::Session.new("SHOP_NAME.spiffystores.com", token)

  3. The session must be activated before use:

    SpiffyStoresAPI::Base.activate_session(session)

  4. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:

    shop = SpiffyStoresAPI::Store.current

# Get a specific product
product = SpiffyStoresAPI::Product.find(123123)

# Create a new product
new_product = SpiffyStoresAPI::Product.new
new_product.title = "Spiffy Stores T-Shirt"
new_product.product_type = "Shirt"
new_product.vendor = "Spiffy Stores"
new_product.save

# Update a product
product.handle = "spiffy-stores-t-shirt"
product.save

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

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

  5. If you want to work with another shop, you'll first need to clear the session:

    SpiffyStoresAPI::Base.clear_session

Using Development Version

Download the source code and run:

rake install

Additional Resources

API Reference: https://www.spiffystores.com.au/kb/API_Reference

Copyright

Copyright (c) 2018 Spiffy Stores

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.