New version 2.0 of the library. Pushing the V3 version to a separate branch and combining the 2 repositories for the PHP Open API client that are livep.

Author: derkmdt

README.md

@@ -1,42 +1,61 @@
-phpexamplecode
-==============
-If you want to contribute to this code sample. You can do a Fork and a Pull request on this repo.
+# bol.com OpenAPI PHP client #
 
-This application does the following requests:
-------------------------------------------
+Client library with example code for using the bol.com Open API Version 4. If you need a client/example for Version 3 of the Open API you can use https://github.com/devbolcom/bolcom-openapi-php-client/tree/bolcom-openapi-php-client-v3
+
+If you want to contribute to this library. You can do a Fork and a Pull request on this repo.
+
+## The library contains the following requests that are also included in the example script: ##
 - Ping request
 - Product request
-- Recommandation request
-- Listresults request
-- Searchresults request
+- Recommendation request
+- RelatedProducts request
+- Offer request
+- Lists request
+- Search request
+- Sessions request
 - Basket requests
+- Wishlist requests
+- setReferrer request (You need to ask extended permission from Developer Center team for this request)
+- Auth requests (You need to ask extended permission from Developer Center team for this request)
 
-What are the files included:
-------------------------------
+## What are the files included: ##
+### Client ###
 - Request.php:
  - Setup connection with the server
- - Combining the String to sign digital
- - Hash based on HMAC-SHA256 (with Base64)
-- TestClient.php:
- - Example code todo a request (place the right URL and call the methods in Request.php)
-- App.php
+ - Send session with header
+- Client.php:
+ - Example code todo a request
+- Accessories.php, Basket.php, BasketItem.php, BasketItemProduct.php, Category, CategoryRefinement.php, Offers.php, Product.php, ProductFamilies.php and Product.php
+ - Example classes for getting the objects
+
+### Example ###
+- Example.php
  - Main class to run the application
-- Category.php, CategoryRefinement.php, Basket.php, BasketItem.php, BasketProduct.php and Product.php
- - Example classes for getting the Category, CategoryRefinement, Basket and Product object
-- Config.php
- - File to set the Key and Secret and other stuff
 - index.php
- - Call to the class "App" and a global function to load the classes
+ - Call to the class "Example" with key, format and debug_mode and a global function to load the classes
 
+## Minimum requirements: ##
+1. PHP 5.3.2 (or higher)
 
-Minimum requirements:
-----------
-1. PHP 5.0 (or higher)
 
+## Installation and running the example: ##
 
-Installation and running the application:
-------------------------------------
-1. Get the code by forking or downloading the zip
+1. Get the code by forking or downloading the zip or installing Composer
 2. Upload all files (keep the directory structure) to a web-server
-3. Edit the file "config.php" to add the right AccessKeyID and SecretAccessKey (request this key and secret at https://developers.bol.com/inloggen/?action=register)
-4. Open the browser and call the URL where your index.php file is located
+3. Edit the example file "examples/Example.php" to add the right AccessKeyID (request this key at https://developers.bol.com/inloggen/?action=register), response format (xml/json) and debug mode bool (0/1)
+4. Open the browser and call the URL where your index.php file is located
+
+## Developer Documentation ##
+http://developers.bol.com/documentatie/handleiding/
+
+## Basic Example ##
+See the examples/ directory for examples of the key client features.
+```PHP
+<?php
+	function __autoload($name) {
+		require('/src/bolcom/' . $name . '.php');
+	}
+	$apiClient = new Client("YOUR_APP_KEY","RESPONSE_FORMAT","DEBUG_MODE");
+	$response = $apiClient->getProduct('1002004010708531');
+	var_dump($response);
+```