semantics3-ruby is a Ruby client for accessing the Semantics3 Products API, which provides structured information, including pricing histories, for a large number of products.
API documentation can be found at https://docs.semantics3.com/reference.
Visit https://www.semantics3.com for more information.
semantics3-ruby can be installed through the RubyGem system:
gem install semantics3
To build and install from the latest source:
git clone git@github.com:Semantics3/semantics3-ruby.git
cd semantics3-ruby
gem build semantics3.gemspec
gem install semantics3-<VERSION>.gem
In order to use the client, you must have both an API key and an API secret. To obtain your key and secret, you need to first create a Semantics3 account. You can access your API access credentials from the user dashboard at https://dashboard.semantics3.com.
Let's lay the groundwork.
require'semantics3'# Your Semantics3 API CredentialsAPI_KEY='SEM3xxxxxxxxxxxxxxxxxxxxxx'API_SECRET='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'# Set up a client to talk to the Semantics3 APIsem3=Semantics3::Products.new(API_KEY,API_SECRET)Let's run our first request! We are going to run a simple search for the word "iphone" as follows:
# Build the requestsem3.products_field("search","iphone")# Run the requestproductsHash=sem3.get_products()# View the results of the requestputsproductsHash.to_jsonThe following requests show you how to interface with some of the core functionality of the Semantics3 Products API:
The example in our "Hello World" script returns the first 10 results. In this example, we'll scroll to subsequent pages, beyond our initial request:
# Build the requestsem3.products_field("search","iphone")# Run the requestproductsHash=sem3.get_products()# View the results of the requestputsproductsHash.to_json# Goto the next 'page'page=0while(productsHash=sem3.iterate_products)dopage=page + 1puts"We are at page = #{page}"puts"The results for this page are:\n"putsproductsHash.to_jsonendRunning a UPC/EAN/GTIN query is as simple as running a search query:
# Build the requestsem3.products_field("upc","883974958450")sem3.products_field("fields",["name","gtins"])# Run the requestproductsHash=sem3.get_products()# View the results of the requestputsproductsHash.to_jsonGet the picture? You can run URL queries as follows:
sem3.products_field("url","http://www.walmart.com/ip/15833173")productsHash=sem3.get_products()putsproductsHash.to_jsonFilter by price using the "lt" (less than) tag:
sem3.products_field("search","iphone")sem3.products_field("price","lt",300)productsHash=sem3.get_products()putsproductsHash.to_jsonTo lookup details about a cat_id, run your request against the categories resource.
Acceptable values for cat_id can be found on the category tree described here.
# Build the requestsem3.products_field("cat_id",4992)# Run the requestproductsHash=sem3.get_products()# View the results of the requestputsproductsHash.to_jsonYou can use webhooks to get near-real-time price updates from Semantics3.
You can register a webhook with Semantics3 by sending a POST request to "webhooks" endpoint.
To verify that your URL is active, a GET request will be sent to the registered address with a verification_code parameter. Your application must read the verification_code query parameter and respond to this request with its value in the response body to complete the verification process.
params={"webhook_uri"=>"http://mydomain.com/webhooks-callback-url"}res=sem3.run_query("webhooks","POST",params)putsresTo fetch existing webhooks
res=sem3.run_query("webhooks","GET")putsresTo remove a webhook
webhook_id="7JcGN81u"endpoint="webhooks/"+webhook_idres=sem3.run_query(endpoint,"DELETE")putsresOnce you create a webhook, you can start adding events to it. Semantics3 will send you notifications when these events occur.
To register events for a specific webhook send a POST request to the "webhooks/{webhook_id}/events" endpoint
params={"type"=>"price.change","product"=>{"sem3_id"=>"1QZC8wchX62eCYS2CACmka"},"constraints"=>{"gte"=>10,"lte"=>100}}webhook_id='7JcGN81u'endpoint="webhooks/#{webhook_id}/events"eventObject=sem3.run_query(endpoint,"POST",params)putseventObject["id"]putseventObject["type"]putseventObject["product"]To fetch all registered events for a give webhook
webhook_id="7JcGN81u"endpoint="webhooks/#{webhook_id}/events"res=sem3.run_query(endpoint,"GET")putsresOnce you have created a webhook and registered events on it, notifications will be sent to your registered webhook URI via a POST request when the corresponding events occur. Make sure that your server can accept POST requests. Here is how a sample notification object looks like
{"type": "price.change","event_id": "XyZgOZ5q","notification_id": "X4jsdDsW","changes": [{"site": "abc.com","url": "http://www.abc.com/def","previous_price": 45.50,"current_price": 41.00},{"site": "walmart.com","url": "http://www.walmart.com/ip/20671263","previous_price": 34.00,"current_price": 42.00}]}Use GitHub's standard fork/commit/pull-request cycle.
If you have any questions, email support@semantics3.com.
- Sivamani VARUN varun@semantics3.com
- Mounarajan mounarajan@semantics3.com
Copyright (c) 2017 Semantics3 Inc.
The "MIT" License
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.