Wire Documentation

This document is intended for any web programmer that needs to use Dakis Wire system. A good knowledge of PHP and JavaScript languages is highly recommended since every example in this document use these languages. It is possible, however, to use any other web programming language to interact with the Wire as long as they provide libraries to send HTTP request, and parse either JSON or YAML data format. Appendix A of this document mentions a few of these libraries.

The Dakis Wire system helps any web developer to handle e-commerce basic data. This data include:

Product Line management
Product Search
Product detailed description
Accessory Search
Shopping Cart Management

In the next section of this document, we will first examine in detail the syntax of wire request; we will then present a few use-cases to illustrate this syntax. At any point, you may also refer to the glossary at the end of the document to understand some business related words.

Wire Requests

As mentioned in the introduction, querying Dakis Wire is done through HTTP requests. This section of the document explains the Syntax of every possible HTTP-GET request to the Wire.

Product Lines

Syntax: http://wire.mydakis.com/product_line?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
organize_by_package	Mandatory	"true" to organize the output by package (category) of decision models, "false" otherwise
search[“text”]	Optional	Used to find the given text in parameter in the product description.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Products

Syntax: http://wire.mydakis.com/product?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
products_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first product to include in the search. To add many products models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
presentation	Mandatory	Can be: overview: To just have an overview of the products detail: To have the detail of the products
search[“text”]	Optional	Used to find the given text in parameter in the product description.
search[“spec_value_ids”]	Optional	Used after a parametric search to filter the result.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	true to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Merchandises

Syntax: http://wire.mydakis.com/merchandise?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
skus[0]	Optional	Generic unique id (same format than retailer_guid) of the first related merchandize SKU number. To add many skus, use &sku[1]=(second sku) , &sku[2]=(3rd sku) and so on.
tags[0]	Optional	Used to display retailer specific tag for merchandise. To add many tags, use &tags[1]=(second tag) , &tag[2]=(3rd tag) and so on.
products_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first product to include in the search. To add many products models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
presentation	Mandatory	Can be: overview: To just have an overview of the products detail: To have the detail of the products
search[text]	Optional	Use this to find text in any field of the given product. Search text will pass through every specifications of the product to find the given keyword.
search[spec_value_ids]	Optional	Used after a parametric search to filter the result.
accessory_count	Optional	"true" to include the accessory count, "false" otherwise.
search[price][max]	Optional	Maximum price to be displayed
search[price][min]	Optional	Minimum price to be displayed
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Parametric search

Syntax: http://wire.mydakis.com/parametric_search?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
decision_models_guids[0]	Mandatory	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
minimum_value_count	Optional	When setting the minimum_value_count, you filter out specification search when all products shares the same value. For example: if every camera listed are 4 megapixel, it is not useful to search by resolution.
accessory_count	Optional	"true" to include the accessory count, "false" otherwise.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Shopping cart (list items)

Syntax: http://wire.mydakis.com/cart?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
session_id	Mandatory	Id generated every time a user open a new shopping cart. This id let us manage the cart until the checkout.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Shopping cart (add item)

Syntax: http://wire.mydakis.com/cart/add_item?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
session_id	Mandatory	Id generated every time a user open a new shopping cart. This id let us manage the cart until the checkout.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.
token	Mandatory for Ajax	Set the temporary token required by the Wire server to accept request coming from non white listed IP.
merchandise_id	Mandatory	Id of the merchandise to be added to the shopping cart. This id is included in the result of the Merchandise query.

(back to top)

Shopping cart (remove item)

Syntax: http://wire.mydakis.com/cart/remove_item?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
session_id	Mandatory	Id generated every time a user open a new shopping cart. This id let us manage the cart until the checkout.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.
token	Mandatory for Ajax	Set the temporary token required by the Wire server to accept request coming from non white listed IP.
item_id	Mandatory	Id of the item to be removed from shopping cart. This id is included in the result of the list cart query. This id is different than the merchandise_id.

(back to top)

Shopping cart (update quantity)

Syntax:

http://wire.mydakis.com/cart/increment?(parameters...)

http://wire.mydakis.com/cart/decrement?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
session_id	Mandatory	Id generated every time a user open a new shopping cart. This id let us manage the cart until the checkout.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.
token	Mandatory for Ajax	Set the temporary token required by the Wire server to accept request coming from non white listed IP.
item_id	Mandatory	Id of the shopping cart item having its quantity updated. This id is included in the result of the list cart query. This id is different than the merchandise_id.

(back to top)

Accessory

Syntax: http://wire.mydakis.com/accessory?(parameters...)

Parameter	Optional	Description
retailer_guid	Mandatory	Unique ID of your retailer. It is a 32 digits hexadecimal number separated by some "-"
skus[0]	Optional	Generic unique id (same format than retailer_guid) of the first SKU number of the related merchandise. To add many skus, use &sku[1]=(second sku) , &sku[2]=(3rd sku) and so on.
tags[0]	Optional	Used to display retailer specific tag for merchandise. To add many tags, use &sku[1]=(second sku) , &sku[2]=(3rd sku) and so on.
products_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first product to include in the search. To add many products models, increase the number between the “[]”. [1] for the second one, [2] for the 3rd one, and so forth.
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
Presentation	Mandatory	Can be: overview: To just have an overview of the products detail: To have the detail of the products
search[text]	Optional	Use this to find text in any field of the given product. Search text will pass through every specifications of the product to find the given keyword.
search[spec_value_ids]	Optional	Used after a parametric search to filter the result.
accessory_count	Optional	"true" to include the accessory count, "false" otherwise.
search[price][max]	Optional	Maximum price to be displayed
Search[price][min]	Optional	Minimum price to be displayed
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Decision Model

Syntax: http://wire.mydakis.com/decision_model?(parameters...)

Parameter	Optional		Description
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
include_specs	Optional		"true" when the result should include detailed specification. Otherwise, simply omit this parameter.
include_presentations	Optional		"true" when the result should include product presentation. Otherwise, simply omit this parameter.
organize_by_package	Optional		"true" when the result should be organized by package (group of product lines). Otherwise, simply omit this parameter.
search[text]	Optional		This parameter is used to search decision model based on given text keyword(s). Result is sorted by order of relevance.
search[exact_text]	Optional		This parameter is used to search a decision model who’s name match exactly the given search parameter.
count	Optional		Maximum number of records to return at a time. Default is 1000.
offset	Optional		Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional		Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional		Set the field to be sorted on. Can be any of the parameter of this table as well as "relevance".
sort[asc]	Optional		True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional		Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.
states[]	Optional		Used to filter the result by displaying only the results matching a given states. Possible states are: 0 for "In Development" 1 for "Archived" 2 for "Published" To match multiple states, repeat the parameter for every states. Example: &state[]=1&state[]=2

(back to top)

Specification

Syntax: http://wire.mydakis.com/specification?(parameters...)

Parameter	Optional	Description
include_description	Optional	"true" to include detailed description in the result, "false" otherwise. Default is "false".
decision_models_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first decision model to include in the search. To add many decision models, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
presentation	Optional	"true" to include detailed description in the result, "false" otherwise. Default is false.
product_guids[0]	Optional	Generic unique id (same format than retailer_guid) of the first product to include in the search. To add many products, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
spec_ids[0]	Optional	Id of the first specification to include in the search. To add many specifications, increase the number between the "[]". [1] for the second one, [2] for the 3rd one, and so forth.
count	Optional	Maximum number of records to return at a time.
offset	Optional	Starting point index of the returned records. Example: to return records 20 to 30, you would set the offset to 20 and the count to 10.
lang	Optional	Result language filter. Can be either "en" for English or "fr" for French. Default is English.
sort[on]	Optional	Set the field to be sorted on. Can be any of the parameter of this table.
sort[asc]	Optional	True to set the sorting order ascendant (from lower to higher), false otherwise. Default is false.
format	Optional	Output format of data returned by the query. Can be "json", "yaml" or "ruby_binary". Default is json.

(back to top)

Combo Query

Combo queries simply combine multiple Wire queries in a single http call. This helps lowering network overhead.

Syntax:

http://wire.mydakis.com/combo?queries[QUERY_NAME1][type]=QUERY_TYPE

&queries[QUERY_NAME1][options][OPTION_1]=VALUE_OF_OPTION1

&queries[QUERY_NAME2][options][OPTION_2]=VALUE_OF_OPTION2....

For every sub_query :

a) Choose an arbitrary name (example : « catalog » or « rebates » etc…)

b) Provides all parameters for every queries in an "array” style of URL

Sub query keywords are:

queries[] to specify the related query

queries[NAME_OF_THE_QUERY][type]= to specify the sub type of the query

possible values: accessory, cart, decision_model, merchandise, parametric_search, product,

product_line, specification

queries[NAME_OF_THE_QUERY][options][OPTION_NAME]=for every options of the

sub-queries

Refer to the section combine two queries using a combo query for an example of combo query.

(back to top)

Wire Token

By default, the Wire system only answer requests coming from white listed IP addresses (to get the IP address(es) of your web server(s) added to our white list, contact Dakis customer support). Any HTTP request coming from another IP will be ignored. The only exception to this rule is when an Ajax call needs to be done directly to the Wire server. Ajax call are done directly from the client web-browsers, thus are not part of the white listed IP addresses.

In order to accept these Ajax requests without compromising the security of our servers, we use a temporary randomly generated token. An HTTP request coming from a non white listed IP but carrying the right token will be accepted. After a few minutes, the token is deleted on the wire server side.

Wire tokens are included in the body of every HTTP reply (look for the key “token” in the resulting parsed hashtable). However, for convenience, we also created a request that only returns the token:

Syntax: http://wire.mydakis.com/token (no parameter required)

(back to top)

Examples

We will now put in practice the syntax shown in the previous section and give a few examples on how to use the Wire using PHP and JavaScript code.

List retailer packages and product lines

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // Build the request URL $WIRE_URL = "http://wire.mydakis.com/product_line?output_format=json" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" . "&organize_by_packages=true"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo ">/pre>\n"; ?>

(back to top)

Get items of a product line

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // Build the request URL $WIRE_URL = "http://wire.mydakis.com/merchandise" . "?output_format=json<=en&count=10&presentation=overview" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

(back to top)

Display detailed information of merchandise

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // Build the request URL $WIRE_URL = "http://wire.mydakis.com/merchandise" . "?output_format=json=en&count=1&presentation=detail" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" . "&product_guids[0]=13ec6528-1faf-49c7-b6e4-159038bdd64d"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

(back to top)

Display detailed content of shopping cart

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // Build the request URL $WIRE_URL = "http://wire.mydakis.com/cart?output_format=json" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" . "&session_id=INSERT_SESSION_ID_HERE"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

Note on session_id:

You can provide pretty much any string as the session ID as long as you keep the same one for the whole session. The php function session_id() is probably the easiest solution.

(back to top)

Search product based on various parameters

In this example, we search for cameras between 500$ and 1000$.

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); $WIRE_URL = "http://wire.mydakis.com/parametric_search" . "?lang=en&minimum_value_count=2" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" . "&decision_model_guids[0]=a58a8268-4946-4121-8912-f53ba8efa0ea" . "&search[price][min]=500&search[price][max]=1000"; // NOTE: "a58a8268-4946-4121-8912-f53ba8efa0ea" is the GUID of "Cameras" // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

(back to top)

Execute an AJAX request to the wire

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // This is an empty products request, used only to retreive the WIRE token $WIRE_URL = "http://wire.mydakis.com/products"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Get the Wire Token for later AJAX/Json calls $wire_token = $values["token"]; ?> <html>  <head>  <script src="prototype.js"></script>  <script src="wire_ajax_api.js"></script> <script> // this set the token allowing ajax call to be accepted WireAjaxAPI.token = "<?php echo $wire_token; ?>"; CAMERA_GUID = "a58a8268-4946-4121-8912-f53ba8efa0ea"; // function called when the "Search" button is clicked function search_cameras() { params = "retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" + "&presentation=overview" + "&decision_model_guids[0]=" + CAMERA_GUID + "&search[price][min]=" + $("min_price").value + "&search[price][max]=" + $("max_price").value; WireAjaxAPI.requestThroughScriptTag( "http://wire.mydakis.com", "products", "merchandises", params, "my_callback_function" ); } function my_callback_function(result) { text = ""; if (result.data.decision_models && result.data.decision_models[0]) { all_cameras = result.data.decision_models[0].products; for (i = 0; i < all_cameras.length; i++) { camera = all_cameras[i]; text += camera.brand + " " + camera.text + " " + camera.final_price + "$\n"; } } $("results").innerHTML = text; } </script> </head> <body> Camera Search<br> Minimum Price:<input id="min_price" value="500"/><br> Maximum Price:<input id="max_price" value="1000"/><br> <input type="button" value="Search" onclick="search_cameras();"/><br> <pre id="results"> </pre> </body> </html>

(back to top)

Add an item to the shopping cart

The easiest way to add or remove items from the shopping cart is through an Ajax (JSON) call using Dakis Wire JavaScript API.

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // This is an empty products request, used only to retreive the WIRE token $WIRE_URL = "http://wire.mydakis.com/products"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Get the Wire Token for later AJAX/Json calls $wire_token = $values["token"]; ?> <html>  <head>  <script src="prototype.js"></script>  <script src="wire_ajax_api.js"></script> <script> // this set the token allowing ajax call to be accepted WireAjaxAPI.token = "<?php echo $wire_token; ?>"; // this initialize the shopping cart with the proper info WireAjaxAPI.cart.init('INSERT_SESSION_ID_HERE', 'INSERT_RETAILER_ID_HERE', 'en', 'http://wire.mydakis.com'); // this function is called back once the AJAX call is completed function wireOnCartUpdated (cart) { alert("item added successfully to cart"); } </script> </head> <body> Item: Canon EOS Digital Rebel XT outfit (EF 28-90mm III lens) black <br> <img src="http://resources.mydakis.com/1613119b-ab6a-49f8-9ca3-24c7c335814c/125/125"/> <a href="#" onclick="WireAjaxApi.cart.buy(296855)">Add To Cart</a> </body> </html>

(back to top)

Remove an item from the shopping cart

Removing an item from the shopping cart is pretty much the same procedure than adding it. It is done through and AJAX call.

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // This is an empty products request, used only to retreive the WIRE token $WIRE_URL = "http://wire.mydakis.com/products"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Get the Wire Token for later AJAX/Json calls $wire_token = $values["token"]; ?> <html>  <head>  <script src="prototype.js"></script>  <script src="wire_ajax_api.js"></script> <script> // this set the token allowing ajax call to be accepted WireAjaxAPI.token = "<?php echo $wire_token; ?>"; // this initialize the shopping cart with the proper info WireAjaxAPI.cart.init('INSERT_SESSION_ID_HERE', 'INSERT_RETAILER_ID_HERE', 'en', 'http://wire.mydakis.com'); // this function is called back once the AJAX call is completed function wireOnCartUpdated (cart) { alert("item added successfully to cart"); } </script> </head> <body> Item: Canon EOS Digital Rebel XT outfit (EF 28-90mm III lens) black <br> <img src="http://resources.mydakis.com/1613119b-ab6a-49f8-9ca3-24c7c335814c/125/125"/> <a href="#" onclick="WireAjaxApi.cart.removeItem(296855)">Remove</a> </body> </html>

(back to top)

Change the quantity of an item in the shopping cart

In this example, we have hardcoded the merchandise ID to 296855. In normal usage, that merchandise ID should be coming from another merchandise query previously sent to the wire.

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // This is an empty products request, used only to retreive the WIRE token $WIRE_URL = "http://wire.mydakis.com/products"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Get the Wire Token for later AJAX/Json calls $wire_token = $values["token"]; ?> <html>  <head>  <script src="prototype.js"></script>  <script src="wire_ajax_api.js"></script> <script> // this set the token allowing ajax call to be accepted WireAjaxAPI.token = "<?php echo $wire_token; ?>"; // this initialize the shopping cart with the proper info WireAjaxAPI.cart.init('INSERT_SESSION_ID_HERE', 'INSERT_RETAILER_ID_HERE', 'en', 'http://wire.mydakis.com'); // this function is called back once the AJAX call is completed function wireOnCartUpdated (cart) { $('the_quantity').innerHtml=cart.items[296855]['quantity']; } </script> </head> <body> Item: Canon EOS Digital Rebel XT outfit (EF 28-90mm III lens) black <br> <img src="http://resources.mydakis.com/1613119b-ab6a-49f8-9ca3-24c7c335814c/125/125"/> <br> Quantity: <span id="the_quantity">1</span> <a href="#" onclick="WireAjaxApi.cart.incrementItem(296855)">+</a> <a href="#" onclick="WireAjaxApi.cart.decrementItem(296855)">-</a> </body> </html>

(back to top)

Make a text search on all products

In the following example, we search for every "PowerShot" product. Most relevant products will be shown first.

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); $WIRE_URL = "http://wire.mydakis.com/merchandise?lang=en" . "&count=10&presentation=overview" . "&retailer_guid=INSERT_YOUR_RETAILER_GUID_HERE" . "&search[text]=PowerShot" . "&sort[on]=relevance"; // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

(back to top)

Combine two queries using a combo query

In this example, we combine the queries of examples 1 and 2. The result will be stored in named array index "query_one" for the first query and "query_two" for the second one. These are arbitrary names (any other word could be used).

<?php // Helper PHP library provided by Dakis require_once('Helpers.php'); // Build the request URL $WIRE_URL = "http://wire.mydakis.com/combo?output_format=json" . "&queries[query_one][type]=product_line" . "&queries[query_one][options][retailer_guid]=" . "INSERT_YOUR_RETAILER_GUID_HERE" . "&queries[query_one][options][organize_by_packages]=true" . "&queries[query_two][type]=merchandise" . "&queries[query_two][options][retailer_guid]=" . "INSERT_YOUR_RETAILER_GUID_HERE" . "&queries[query_two][options][count]=10" . "&queries[query_two][options][presentation]=overview" // Send the HTTP request $request = new HTTPRequest($WIRE_URL); $json = $request->DownloadToString(); // Parse the Json result $values = json_decode($json, true); // Display the results echo "<pre>\n"; print_r($values); echo "</pre>\n"; ?>

(back to top)

Glossary

Accessory:	Type of merchandise who is related to another item. For example, lens is an accessory of camera.
Combo Query:	A combo query is the combination of multiple queries to the wire into a single tree based query.
Decision Model:	Decision model are unique category of products. Decision models are shared by all retailers.
GUID:	Stands for “Global Unique Identifier”. You can refer to http://en.wikipedia.org/wiki/Globally_Unique_Identifier for more information on GUIDs.
Merchandise:	Merchandise is an instance of a product for a specific retailer. It contains all information of the product that is unique for a given retailer. Price is an example of such retailer specific information.
Package:	A package is a group of product lines. For example “Printers and Scanners” would be a package including the following product lines “Paper, Ink Cartiges, Scanners, Printers”.
Product:	A product is a definition, shared by all retailers, of an item. Product only defines the item itself, not the price or other information that is different from one retailer to another. Refer to merchandise for retailer specific information.
Product Line:	Product line is very similar to decision model, except that it belongs to one retailer only. The list of product lines of a given retailer defines what the decision models available are for this retailer.
Parametric Search:	Parametric search let the consumer find products by specifying various parameters. For example, you can get all cameras having at least 4 mega pixels by doing a parametric search on resolution.
Retailer:	Every store using Dakis to sell items or display items for sales is a retailer. Retailers have their own GUID used to identify them.
SKU:	Stands for Stock-Keeping Unit. It is a unique number identifying a product or a service. Refer to http://en.wikipedia.org/wiki/Stock_Keeping_Unit for more information.
Shopping Cart:	Shopping cart includes every merchandise and their related quantities a consumer is about to buy. Before the checkout, a consumer may add or remove as many item from its shopping cart.
Specification:	Specification is detailed information regarding a product. For example, “Resolution” is a specification of every “Camera” and has its value expressed in mega pixels.
Wire token:	Token sent from the wire that can be reused by AJAX queries directly to the wire afterwards. Any HTTP request made to the wire that are not from white listed IP addresses require this token to be accepted. Request sent directly from white listed server does not require this token.

(back to top)

Other languages ressources

Ruby on rails

HTTP request to the wire:

To send HTTP request to the wire, you can use the Net::HTTP object.

YAML parsing:

Parsing YAML data with ruby on rails is pretty straightforward. Simply use YAML::parse() method. It is part of Rails core and does not require any specific gem.

JSON parsing:

Parsing JSON in ruby requires to install the JSON gem (gem install json). Once done, simply use JSON.parse().

(back to top)

ASP.NET

HTTP request to the wire:

To send HTTP request to the wire using ASP.NET, you can use HttpWebRequest object. An example can be found here:

http://www.worldofasp.net/tut/WebRequest/Working with_HttpWebRequest_and_HttpWebResponse_in_ASPNET_114.aspx

YAML parsing:

There is no built-in YAML parser in ASP.NET. There are a few open source library available to do it though. One is available here:

http://www.codeproject.com/KB/recipes/yamlparser.aspx

JSON parsing:

You can parse JSON data in ASP.NET using the Jayrock open source library. For more information, please visit this link: http://msdn.microsoft.com/en-us/library/bb299886.aspx

(back to top)

Java/JSP

HTTP request to the wire:

To send HTTP request to the wire in Java/JSP, you can use the URL.openStream() method and then read all data from that stream. For more information:

http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html#openStream()

YAML parsing:

You can use JYaml library to parse YAML data from the Wire. For more information: http://jyaml.sourceforge.net/tutorial.html

JSON parsing:

You can parse JSON in Java/JSP using the “JSON in Java” library. It is available here: http://www.json.org/java/index.html. Simply use the following JSONObject constructor: http://www.json.org/javadoc/org/json/JSONObject.html#JSONObject(java.lang.String)

(back to top)

Perl

HTTP request to the wire:

To send HTTP request to the wire in Java/JSP, you can use HTTP::Request object found in libwww-perl. For more information: http://kobesearch.cpan.org/htdocs/libwww-perl/HTTP/Request.html

YAML parsing:

YAML perl module is available here: http://search.cpan.org/dist/YAML/

JSON parsing:

JSON parsing is already available in Perl using built in JSON object. For more information: http://linux.die.net/man/3/json

(back to top)

ColdFusion

HTTP request to the wire:

To send HTTP request to the wire in ColdFusion, you can use CF.http() method. For more information: http://livedocs.adobe.com/coldfusion/6/Using_Server-Side_ActionScript_in_ColdFusion_MX/tags3.htm#1001877

YAML parsing:

At the time this document was written, there is no direct support for YAML in ColdFusion. So we suggest using JSON format instead

JSON parsing:

JSON parsing is already available in ColdFusion 8 and higher using DeserializeJSON. For more information http://livedocs.adobe.com/coldfusion/8/htmldocs/help.html?content=functions_s_03.html#292127

(back to top)

bookmark this site | sitemap