ShopSavvy for Jekyll

Ruby

A Jekyll plugin that adds Liquid tags ({% shopsavvy_product %}, {% shopsavvy_deals %}, {% shopsavvy_price %}) and a shopsavvy_lookup filter for embedding live product data in static sites at build time. Backed by per-build response caching for fast rebuilds.

Set up ShopSavvy for Jekyll

  1. 1

    Get a ShopSavvy Data API key

    Create a key at shopsavvy.com/data. Keys look like ss_live_ followed by 32 characters. Keep it out of source control.

  2. 2

    Install

    Add the ShopSavvy Jekyll integration to your project:

    gem install jekyll-shopsavvy
  3. 3

    Add your API key

    Set the SHOPSAVVY_API_KEY environment variable to your key (shell, .env file or Jekyll's secrets settings), or pass it to the client as the README shows.

  4. 4

    Make your first call

    From the shopsavvy/jekyll-shopsavvy README (Install):

    group :jekyll_plugins do
      gem "jekyll-shopsavvy"
    end

    Copied from the repository README.

  5. 5

    Install

    From the shopsavvy/jekyll-shopsavvy README (Install):

    plugins:
      - jekyll-shopsavvy
    
    shopsavvy:
      api_key: ENV["SHOPSAVVY_API_KEY"]

    Copied from the repository README.

Keys come with a Data API plan. See plans.

Features

{% shopsavvy_product %} Liquid tag with card, inline, and table layouts
{% shopsavvy_deals %} for trending deals with category and grade filters
{% shopsavvy_price %} for inline price text
| shopsavvy_lookup filter for full product data
Per-build response caching to keep rebuilds fast

Use Cases

1.Affiliate review sites built on Jekyll
2.Product comparison pages with live prices
3.Deal aggregator blogs
4.Buyer's guides with current retailer data

What data, how often, which direction

Data
Product records, current offers from tens of thousands of retailers and price history back to 2011, dense from 2019, from the ShopSavvy Data API. Prices are in US dollars.
How often
Every offer carries the time it was last checked. With the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.
Direction
ShopSavvy data flows into Jekyll. Requests carry only what you ask about (identifiers, search terms or schedules) and your API key.

FAQ

Do I need an API key?

Yes. The Jekyll integration calls the ShopSavvy Data API, which needs a Data API key. Create one at shopsavvy.com/data, then add it as the setup steps above show.

What data does it return?

ShopSavvy product records (title, brand, model, barcode, ASIN), current offers from tens of thousands of retailers with price, availability and condition, and price history back to 2011, dense from 2019. Products can be looked up by barcode, ASIN, URL or model number. Prices are in US dollars.

How fresh are the prices?

Every offer carries the time ShopSavvy last checked it, so you can see how current each price is. Through the Data API you can schedule refreshes hourly, daily or weekly for retailers we can re-check through an official retailer API; other retailers update as ShopSavvy sees them.

Is my API key stored securely?

The README has you supply it through the SHOPSAVVY_API_KEY environment variable or your own configuration, so it stays out of source code. The key is sent to the ShopSavvy API (api.shopsavvy.com) over HTTPS in the Authorization header. You can revoke a key and create a new one at shopsavvy.com/data/api-keys.

Is it open source?

Yes. The source is on GitHub at https://github.com/shopsavvy/jekyll-shopsavvy under the MIT license.

Powered by the ShopSavvy Data API

This integration connects to the ShopSavvy Data API: product data and current prices from tens of thousands of retailers, across 30M+ products, with price history back to 2011, dense from 2019. Look up products by barcode, ASIN, URL or keyword, compare prices, read history and schedule refreshes.