---------------------------------------------------------------------------

	             PRICE COMPARISON
		     DATA-API README

---------------------------------------------------------------------------
							DATED : 29/9/2016
---------------------------------------------------------------------------


What is Data-Api
================

The data-api is a way to port your websites data to outside applications.
It works on REST calls which can be used to get categories, brands, stores,
products and prices data in xml or json format.


How to use Data-Api
===================

You can setup in admin area the publishers that are allowed to access the
data. Once you have created the publisher, now the api can be accessed using
the following url:

http://www.domain.com/data-api/?type=_type_&id=_publisher_id_&key=_api_key_&act=_action_

where:

_type_ can be one of json or xml (default is json)

_publisher_id_ is the publisher id created in admin

_api_key_ is the publisher api key created in admin

_action_ can be one of the following:

	ver:		to get the api version

	catslist:	to get the list of categories based on below parameters
		cids:	comma separated category ids to get only those categories
		pids:	comma separated parent ids to get only childs of those parents (set to 0 to get only root categories)

	catstree:	to get the full category taxonomy in tree format

	brands:		to get full list of brands with logo urls

	stores:		to get full list of stores with logo urls

	products:	to get list of products based on below parameters
		cid:	category id		(either this category id or the 
		kwd:	search keyword		 search keyword must be provided)
		sortk:	sort records by		default: minprice (values: minprice, stores, name)
		sortm:	sort records mode	default: asc (values: asc, desc)
		pgno:	page number		default: 1 (1 - 100)
		max:	max records		default: 20 (5 - 100)

	product:	to get the information of a product
		prod:	product id
