semantics3-csharp is a C# client for accessing the Semantics3 Products API, which provides structured information, including pricing histories, for a large number of products. See https://www.semantics3.com for more information.
Quickstart guide: https://www.semantics3.com/quickstart API documentation can be found at https://www.semantics3.com/docs/
semantics3-csharp can be installed through the Nuget. Nuget: https://www.nuget.org/packages/Semantics3/. Target Frameworks for this library build are .NET Framework 4.0 and .NET Framework 4.5. Change your Target Framework from .NET Framework 4.0 (or 4.5) Client Profile to just .NET Framework 4.0 (or 4.5) in your project properties if need to.
$ Install-Package Semantics3To build and install from the latest source:
$ git clone git@github.com:Semantics3/semantics3-csharp.git- Google.GData.Client >= 2.2.2.0
- Newtonsoft.Json >= 5.0.6
- .NET Framework >= 4.0
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 an account at https://www.semantics3.com/ You can access your API access credentials from the user dashboard at https://www.semantics3.com/dashboard/applications
Let's lay the groundwork.
using Semantics3;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
namespace MyApp
{
class Program
{
static void Main(string[] args)
{
Products products = new Products("APIKEY",
"APISECRET");
}
}
}Let's make our first query! For this query, we are going to search for all Toshiba products that fall under the category of "Computers and Accessories", whose cat_id is 4992.
// Build the query
products.products_field( "cat_id", 4992 );
products.products_field( "brand", "Toshiba" );
// Make the query
JObject hashProducts = products.get_products();
// View the results of the query
Console.Write(hashProducts.ToString());The following examples show you how to interface with some of the core functionality of the Semantics3 Products API. For more detailed examples check out the Quickstart guide: https://www.semantics3.com/quickstart
In this example we are going to be accessing the categories endpoint. We are going to be specifically exploring the "Computers and Accessories" category, which has a cat_id of 4992. For more details regarding our category tree and associated cat_ids check out our API docs at https://www.semantics3.com/docs
// Build the query
products.categories_field( "cat_id", 4992 );
// Make the query
JObject hashCategories = $sem3->get_categories();
// View the results of the query
Console.Write(hashCategories.ToString());You can construct complex queries by just repeatedly calling the products_field() or add() methods. Here is how we translate the following JSON query:
{
"cat_id" : 4992,
"brand" : "Toshiba",
"weight" : { "gte":1000000, "lt":1500000 },
"sitedetails" : {
"name" : "newegg.com",
"latestoffers" : {
"currency": "USD",
"price" : { "gte" : 100 }
}
}
}This query returns all Toshiba products within a certain weight range narrowed down to just those that retailed recently on newegg.com for >= USD 100.
// Build the query
products.products_field("cat_id", 4992);
products.products_field("brand", "Toshiba");
products.products_field("weight", "gte", 1000000);
products.products_field("weight", "lte", 1500000);
products.products_field("sitedetails", "name", "newegg.com");
products.products_field("sitedetails", "latestoffers", "currency", "USD");
products.products_field("sitedetails", "latestoffers", "price", "gte", 100);
products.remove("products", "weight", "gte");
products.remove("products", "weight", "lte");
// Let's make a modification - say we no longer want the weight attribute
products.remove( "products", "weight", "gte" );
// Let's view the JSON query we just constructed. This is a good starting point to debug, if you are getting incorrect
// results for your query
String constructedJson = products.get_query_json( "products" );
Console.Write(constructedJson);
// Make the query
JObject apiResponse = products.get_products();
// View the results of the query
Console.Write(apiResponse.ToString());Let's now look at doing pagination, continuing from where we stopped previously.
// Goto the next 'page'
int page = 1;
JObject nextProducts = products.iterate_products();
while( nextProducts != null )
{
Console.Write("We are at page"); Console.Write(page);
Console.Write(nextProducts.ToString());
page++;
nextProducts = products.iterate_products();
}We shall use the add() method, which allows you to access any of the supported endpoints by just specifiying the name of the endpoint. add( "products", param1, param2, ...) is the equivalent of products_field( param1, param2, ... ), add( "offers", param1, param2, ... ) is the equivalent of offers_field( param1, param2, ...)
For this example, we are going to look at a particular product that is sold by select mercgants and whose price is >= USD 30 and seen after a specific date (specified as a UNIX timestamp).
// Build the query
products.add( "offers", "sem3_id", "4znupRCkN6w2Q4Ke4s6sUC");
String[] sellers = new String[] {"LFleurs","Frys","Walmart"};
products.add( "offers", "seller", sellers );
products.add( "offers", "currency", "USD");
products.add( "offers", "price", "gte", 30);
products.add( "offers", "lastrecorded_at", "gte", 1348654600);
// Make the query
JObject apiResponse = products.get_offers();
// Alternatively we could also do
JObject apiResponse = products.get_results( "offers" );
// View the results of the query
Console.Write(apiResponse.ToString());The code below shows how to use the JObject (from Newtonsoft.Json library) value returned from the Semantics3 API to access the data fields interested in. The JSON response from the API is already parsed into the Newtonsoft.Json Object ready to be consumed easily in your target application.
// Query the API
JObject hashResponse = products.get_products();
if ((int)hashResponse["results_count"] > 0)
{
JArray arrayProducts = (JArray)hashResponse["results"];
// For each product in the results
for (int i = 0; i < arrayProducts.Count; i++)
{
String productTitle = (String)arrayProducts[i]["name"];
List<String> images = new List<string>();
for (int j = 0; j < ((JArray)arrayProducts[i]["images"]).Count; j++)
{
images.Add((String)arrayProducts[i]["images"][j]);
}
// Pricing Information
JArray ecommerceStores = (JArray)arrayProducts[i]["sitedetails"];
for (int k = 0; k < ecommerceStores.Count; k++)
{
String skuInStore = (String)ecommerceStores[k]["sku"];
String productUrlInStore = (String)ecommerceStores[k]["url"];
// Latest offers from the ecommerceStore
for (int s = 0; s < ((JArray)ecommerceStores[k]["latestoffers"]).Count; s++)
{
String sellerName = (String)ecommerceStores[k]["latestoffers"][s]["seller"];
String price = (String)ecommerceStores[k]["latestoffers"][s]["price"];
String currency = (String)ecommerceStores[k]["latestoffers"][s]["currency"];
String availability = (String)ecommerceStores[k]["latestoffers"][s]["availability"];
// Preprocess and use in application ...
}
// Parsed offers
}
// Loop Ecommerse stores
}
// Loop each product in the api response
}
// If the above query resulted in some resultsInstall this library through Nuget package manager using the instructions above. After installing the library in your project (Make sure your target framework is .NET 4 (or later) and NOT .NET 4(or later) Client Framework , can be changed in Properties->Compile->Advanced Compile Options->Target Framework), here's a sample VB .NET code on using the API. All of the above library functions work the same in VB as the Semantics3 API C# library is CLS Compliant.
Imports Semantics3
Imports Newtonsoft.Json
Imports Newtonsoft.Json.Linq
Module Module1
Sub Main()
Dim products As Products = New Products("API_KEY", "API_SECRET")
' Build the query
products.products_field("cat_id", 4992)
products.products_field("brand", "Toshiba")
products.products_field("weight", "gte", 1000000)
products.products_field("weight", "lte", 1500000)
Dim constructedJson As String = products.get_query_json("products")
Console.Write(constructedJson)
' Make the query
Dim apiResponse As JObject = products.get_products()
Console.Write(apiResponse.ToString())
End Sub
End Module
Use GitHub's standard fork/commit/pull-request cycle. If you have any questions, email support@semantics3.com.
- Srinivasan Kidambi srinivas@semantics3.com
Copyright (c) 2013 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.