ExShopCatalog
BiDiShop's RSS Web Service for osCommerce data compliant eCommerce (extended version)
This service helps building RSS feeds and displaying data out of the catalog of an osCommerce MS2.2 compliant Database.
See bidiweb.com.
Copyright (c) 2007 B.Degoy
This version is under developpement. It should not be used for production applications.
The following operations are supported. For a formal definition, please review the Service Description.
-
TestDataBaseAccess
Test the database connection and returns detailled error message, or an "Ok" string if no error occured. -
getAppSessionId
Returns Id of current client's Application Session. Only needed for error management. -
getImagePath
Returns the path to products images. -
getLastErrorCode
Returns service error code related to last client operation, or 0 if no error occured during last operation. -
getLastErrorMessage
Returns service error message related to last client operation, or an empty string if no error occured during last operation. -
getLastSystemErrorCode
Returns service global (not client related) error code, or 0 if no error occured. -
getLastSystemErrorMessage
Returns service global (not client related) error message, or an empty string if no error occured. -
getProductsLink
Returns the URL, path, page and pamameter to products details. Just append the product Id to get product details page. -
getRSS
Returns a RSS Feed of products selected by the folowing parameters:
CatId: Product Category Id; subcategories are included.
Keys: Keywords to search in product title, description and model.
LangId: Language Id. -
getShopURL
Returns the URL of client's merchant site. -
getWsName
Returns Name and Version of this Web Service. -
getXMLProductsSimpleSearch
Returns a XML structure of products selected by the folowing parameters:
CatId: Product Category Id; subcategories are included.
Keys: Keywords to search in product title, description and model.
LangId: Language Id
Data is returned in a proprietary formated XML structure, see help. -
isAppSessionAlive
Returns True if current client's Application Session is alive. -
setAuthor
Client may set there the RSS channel author's name. -
setConnectionParameters
Instead of setting the ConnectionString parameter, client may give the four parameters needed to connect to his shop database. The values of those parameters are known by the shop's database administrator, and you may find theese values in the "catalog/includes/configure.php file":
Server: The full address of the database server (ie: "http://the_mysql_server.com/".
Database: The name of the shop database.
UserName: The user login to database.
Password: The user password to database. -
setConnectionString
If not setting the four parameters with setConnectionParameters(), client should set there the ODBC connection string to his shop database. Be sure to read the documentation to set properly this value . -
setCssFile
Client may set a css file path and name (default to news.css). -
setDescription
Client may set there the RSS channel description. -
setImagePath
Client may set there the path to directory holding image of products, relative to own site root. If left blank, defaults to "catalog/images/". -
setOptions
Client may set there some options or switches. -
setProductsLink
Client may set there the URL, path, page and pamameter to products details, so that the service only needs to append the product Id to get the full URI of product details page. If left blank, defaults to "catalog/product_info.php?products_id=" -
setShopURL
Client should set there the URL of his merchant site. -
setXmlFile
Client may set a xml file path and name (default to news.xml).