krpec / PrestaSharp

CSharp .Net client library for the PrestaShop API via web service

#PrestaSharp ###CSharp .Net client library for the PrestaShop API via web service

##Introduction A simple .Net REST client written in C# for the Prestashop API. PrestaSharp uses the RestSharp library to consume the Prestashop services.

##Basic usage

1. Initiate a client instance:

	string BaseUrl = "http://www.myweb.com/api";
	string Account = "ASDLKJOIQWEPROQWUPRPOQPPRQOW";
	string Password = "";
	ManufacturerFactory ManufacturerFactory = new ManufacturerFactory(BaseUrl, Account, Password);

2. Perform CRUD actions through the client:

	PrestaSharp.Entities.manufacturer Manufacturer = ManufacturerFactory.Get(6);
	Manufacturer.name = "Iron Maiden";
	Manufacturer.active = 1;        
	ManufacturerFactory.Add(Manufacturer);
	ManufacturerFactory.Update(Manufacturer);
	ManufacturerFactory.Delete(Manufacturer);

##Advanced usage

1. Get all. This sample retrieves the list of manufacturers:

	List<manufacturer> manufacturers = ManufacturerFactory.GetAll();

2. Get ids. This sample retrieves the list of the manufacturer ids:

	List<long> ids = ManufacturerFactory.GetIds();

3. Get by filter. This sample retrieves the list of manufacturers which name is "Metallica":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "Metallica");
	List<manufacturer> manufacturers = ManufacturerFactory.GetByFilter(dtn, null, null);

4. Get by filter with wildcards. This sample retrieves the manufacturers which name starts with "Metall":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "[Metall]%");
	List<manufacturer> manufacturers = ManufacturerFactory.GetByFilter(dtn, null, null);

5. Get ids by filter. This sample retrieves the list of the manufacturers ids which name is "Metallica":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "Metallica");
	List<long> ids = ManufacturerFactory.GetIdsByFilter(dtn, null, null);

6. Get ids by filter with wildcards. This sample retrieves the list of the manufacturers ids which name starts with "Metall":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "[Metall]%");
	List<long> ids = ManufacturerFactory.GetIdsByFilter(dtn, null, null);

7. Get by complex filter. This sample retrieves the top five manufacturers in ascendent sorting which name starts with "Metall":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "[Metall]%");
	List<manufacturer> manufacturers = ManufacturerFactory.GetByFilter(dtn, "name_ASC", "5");

8. Get by filter for pagination. This sample retrieves the top five manufacturers from tenth position in ascendent sorting which name starts with "Metall":

	Dictionary<string, string> dtn = new Dictionary<string, string>();
	dtn.Add("name", "[Metall]%");
	List<manufacturer> manufacturers = ManufacturerFactory.GetByFilter(dtn, "name_ASC", "[9,5]");

##Supported resources

• Categories
• Combinations
• Groups
• Images
• Languages
• Manufacturers
• Products
• Product Features
• Product Feature Values
• Product Options
• Product Option Values
• Shops
• Stock Availables
• Tags

##Supported actions

• Create
• Read
• Update
• Delete

##Roadmap

• Add other resources

##License PrestaSharp is GNU General Public License (GPL)

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantabilty or fitness for a particular purpose. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Copyright (C) 2013 Bukimedia

• Bukimedia: http://www.bukimedia.com/
• Twitter: http://twitter.com/bukimedia
• GitHub: https://github.com/bukimedia