Recent changes to API

API modified by Stephan Zavrel

Stephan Zavrel — Sun, 29 May 2016 17:23:01 -0000

--- v21
+++ v22
@@ -95,6 +95,6 @@

 ### Enabling CORS

-For the AngularJS service to work you need to enable CORS on your server if you host easyrec in your own environment. Other we will get errors because of the violation of the Cross Origin Request policies in the browser. The page [enable-cors.org] (http://enable-cors.org/server.html) has a good overview about the most commonly used Web Server implementations and how to enable CORS. 
+For the AngularJS service to work you need to enable CORS on your server if you host easyrec in your own environment. Other we will get errors because of the violation of the Cross Origin Request policies in the browser. The page [enable-cors.org](http://enable-cors.org/server.html) has a good overview about the most commonly used Web Server implementations and how to enable CORS. 
 # Legacy Javascript API
 You can still use our old javascript API as decribed at http://easyrec.sourceforge.net/wiki/index.php?title=JavaScript_API_v0.98. However, this API is considered legagcy. It will not be developed further and misses a lot of new API functions including the profile system.

API modified by Stephan Zavrel

Stephan Zavrel — Sun, 29 May 2016 17:22:19 -0000

--- v20
+++ v21
@@ -51,7 +51,7 @@
 In case you don't use the easyrec demo service but your own hosted setup change the URL accordingly!
 When bootstrapping your AngularJS application, add the `easyrecServices` as a module dependency, e.g.

-var myApplication = angular.module('myapplication', ['myApplicationControllers', 'easyrecServices', 'ngRoute']);
+`var myApplication = angular.module('myapplication', ['myApplicationControllers', 'easyrecServices', 'ngRoute']);`

 Then, in the config block of your application configure the` easyrecProvider` with the appropriate baseURL, tenant and API key:

API modified by Stephan Zavrel

Stephan Zavrel — Sun, 29 May 2016 17:21:23 -0000

--- v19
+++ v20
@@ -41,7 +41,60 @@
 [ImportAPI]

 # AngularJS service
-description coming soon
+As of easyrec 1.0 we provide an AngularJS service for javascript based integration of easyrec. The former Javascript API based on JSON with padding is considered legagcy now and does not support all API calls provided by easyrec. It'll still work but if you want to use easyrec to its full capability yo will have to switch to the AngularJS service or implement your own Javascript client.

+To use the AngularJS service add the following script tag to your application's index.html:
+
+`<script src="http://demo.easyrec.org/api-js/angularjs/easyrec.js"></script>`
+
+
+In case you don't use the easyrec demo service but your own hosted setup change the URL accordingly!
+When bootstrapping your AngularJS application, add the `easyrecServices` as a module dependency, e.g.
+
+var myApplication = angular.module('myapplication', ['myApplicationControllers', 'easyrecServices', 'ngRoute']);
+
+Then, in the config block of your application configure the` easyrecProvider` with the appropriate baseURL, tenant and API key:
+
+~~~
+myApplication.config(['$routeProvider', '$locationProvider','easyrecProvider',
+    function($routeProvider, $locationProvider, easyrecProvider) {
+        ...
+        easyrecProvider.setBaseUrl('http://demo.easyrec.org/easyrec-web');
+        easyrecProvider.setApiKey('8ab9dc3ffcdac576d0f298043a60517a');
+        easyrecProvider.setTenant('EASYREC_DEMO');  
+
+        ...
+    }]).run([...
+~~~
+
+
+You can inject the `easyrec` service as module dependency in your controllers whenever you want to call the easyrec API.
+The best way to see all the available functions of the easyrec AngularJS service is to take a look at the source of the API Tester and Profile API Tester page in the easyrec Admin GUI. An example for a view call can be found below:
+
+~~~
+easyrec.view($scope.sessionid, 
+        $scope.itemid,
+        $scope.itemtype,
+        $scope.itemdescription,
+        $scope.itemurl,
+        $scope.itemimageurl,
+        $scope.userid,
+        $scope.actioninfo,
+        $scope.actiontime,
+        $scope.token).then(
+    function(data, status) {
+        $scope.status = status;
+        $scope.data = data;
+        }, function(data, status) {
+        $scope.status = status;
+        $scope.data = data || "Request failed"; 
+});
+~~~
+                       
+You can take a look at the complete [API Tester source](https://sourceforge.net/p/easyrec/code/ci/1.0.4/tree/easyrec-web/src/main/webapp/jsp/api.jsp) and the easyrec [AngularJS service source](https://sourceforge.net/p/easyrec/code/ci/1.0.4/tree/easyrec-web/src/main/webapp/api-js/angularjs/easyrec.js) to get a better understanding of all the function calls available and how they work.
+
+### Enabling CORS
+
+For the AngularJS service to work you need to enable CORS on your server if you host easyrec in your own environment. Other we will get errors because of the violation of the Cross Origin Request policies in the browser. The page [enable-cors.org] (http://enable-cors.org/server.html) has a good overview about the most commonly used Web Server implementations and how to enable CORS. 
 # Legacy Javascript API
 You can still use our old javascript API as decribed at http://easyrec.sourceforge.net/wiki/index.php?title=JavaScript_API_v0.98. However, this API is considered legagcy. It will not be developed further and misses a lot of new API functions including the profile system.

API modified by Stephan Zavrel

Stephan Zavrel — Fri, 18 Mar 2016 13:57:02 -0000

--- v18
+++ v19
@@ -40,3 +40,8 @@
 # Import and other functions
 [ImportAPI]

+# AngularJS service
+description coming soon
+
+# Legacy Javascript API
+You can still use our old javascript API as decribed at http://easyrec.sourceforge.net/wiki/index.php?title=JavaScript_API_v0.98. However, this API is considered legagcy. It will not be developed further and misses a lot of new API functions including the profile system.

API modified by Stephan Zavrel

Stephan Zavrel — Wed, 05 Aug 2015 13:35:08 -0000

--- v17
+++ v18
@@ -33,6 +33,8 @@
 # Community Rankings
 [RankingsAPI]

+# Clusters
+[ClusterAPI]
 # Profile API
 [ProfileAPI]
 # Import and other functions

API modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:38:33 -0000

--- v16
+++ v17
@@ -38,18 +38,3 @@
 # Import and other functions
 [ImportAPI]

-To use the Import API, the Security Token (e.g. b08f41cfa92b430538146cf474116c6d), which is generated as soon you sign in, has to be used in every Import API call. You can copy the Token form the section on the left under the API key or you can retrieve the Token from 
-> [webapp path]/operator/signin?operatorId=USER&password=PASSWORD
-
-
-which returns an xml like
-
-
-  <easyrec>
-    <action>signin</action>
-    <success code="105" message="User is signed in!"/>
-    <token>b08f41cfa92b430538146cf474116c6d</token>
-  </easyrec>
-
-
-The token is invalidated when you sign out or as soon another user with the same credentials signs in. Note: During an import, make sure no one else signs in under your account, otherwise you will have to update the security token.

API modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:30:11 -0000

--- v15
+++ v16
@@ -27,307 +27,16 @@
 Use UTF-8 encoding when sending arguments to API methods.

 # Sending Actions
-
-## view
-
-### Sample call
-
-**HTTP GET**
-> {*yourServerURL*}/api/1.1/view?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&itemdescription=Fatboy%20Slim%20-%20The%20Rockafeller%20Skank&itemurl=/item/fatboyslim&itemimageurl=/img/covers/fatboyslim.jpg&userid=24EH1723322222A3&sessionid=F3D4E3BE31EE3FA069F5434DB7EC2E34&actiontime=01_01_2009_23_59_59&itemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-sessionid | required |session id of a user. (e.g. "F3D4E3BE31EE3FA069F5434DB7EC2E34")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-itemdescription | required | item description that is displayed when showing recommendations on your Website. (e.g. "the frog")
-itemurl | required | url that links to the item page on your Website.
Note:Please encode &'s in url with %26
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-itemimageurl | optional | An optional item image url that links to a image of the item.
Note:Please encode &'s in url with %26
-actiontime | optional; default: the current system time | An optional action time parameter that overwrites the current timestamp of the action. The parameter has the format "dd_MM_yyyy_HH_mm_ss" (e.g."01_01_2009_23_59_59").        
-itemtype | optional; default:ITEM |An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.). If not supplied the default value ITEM will be used.
-actioninfo | optional | an arbitraray valid JSON object with additional information about he action. The JSON string may be up to **500** characters long.
-
-## buy
-
-### Sample call
-**HTTP GET**
-> {*yourServerURL*}/api/1.1/buy?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&itemdescription=Fatboy%20Slim%20-%20The%20Rockafeller%20Skank&itemurl=/item/fatboyslim&itemimageurl=/img/covers/fatboyslim.jpg&userid=24EH1723322222A3&sessionid=F3D4E3BE31EE3FA069F5434DB7EC2E34&actiontime=01_01_2009_23_59_59&itemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-sessionid | required |session id of a user. (e.g. "F3D4E3BE31EE3FA069F5434DB7EC2E34")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-itemdescription | required | item description that is displayed when showing recommendations on your Website. (e.g. "the frog")
-itemurl | required | url that links to the item page on your Website.
Note:Please encode &'s in url with %26
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-itemimageurl | optional | An optional item image url that links to a image of the item.
Note:Please encode &'s in url with %26
-actiontime | optional; default: the current system time | An optional action time parameter that overwrites the current timestamp of the action. The parameter has the format "dd_MM_yyyy_HH_mm_ss" (e.g."01_01_2009_23_59_59").        
-itemtype | optional; default:ITEM |An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.). If not supplied the default value ITEM will be used.
-actioninfo | optional | an arbitraray valid JSON object with additional information about he action. The JSON string may be up to **500** characters long.
-
-## rate
-
-### Sample call
-**HTTP GET**
-> {*yourServerURL*}/api/1.1/rate?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&itemdescription=Fatboy%20Slim%20-%20The%20Rockafeller%20Skank&itemurl=/item/fatboyslim&itemimageurl=/img/covers/fatboyslim.jpg&userid=24EH1723322222A3&sessionid=F3D4E3BE31EE3FA069F5434DB7EC2E34&actiontime=01_01_2009_23_59_59&itemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-sessionid | required |session id of a user. (e.g. "F3D4E3BE31EE3FA069F5434DB7EC2E34")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-itemdescription | required | item description that is displayed when showing recommendations on your Website. (e.g. "the frog")
-itemurl | required | url that links to the item page on your Website.
Note:Please encode &'s in url with %26
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-itemimageurl | optional | An optional item image url that links to a image of the item.
Note:Please encode &'s in url with %26
-actiontime | optional; default: the current system time | An optional action time parameter that overwrites the current timestamp of the action. The parameter has the format "dd_MM_yyyy_HH_mm_ss" (e.g."01_01_2009_23_59_59").        
-itemtype | optional; default:ITEM |An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.). If not supplied the default value ITEM will be used.
-actioninfo | optional | an arbitraray valid JSON object with additional information about he action. The JSON string may be up to **500** characters long.
-
-
-## sendaction
-While the view, buy and rate calls are tailored towards a typical eCommerce shop application, easyrec allows for the definition of arbitrary new action types as required by the specific use case. You can use the generic *sendaction* API call to send actions of any type to easyrec. Use the *actiontype* parameter to specify the action. **Note:** action types must be created using the Admin GUI prior to being accepted as valid API calls.
-
-### Sample call
-**HTTP GET**
-> {*yourServerURL*}/api/1.1/sendaction?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&actiontype=PUT_INTO_SHOPPINGCART&itemid=42&itemdescription=Fatboy Slim%20-%20The%20Rockafeller%20Skank&itemurl=/item/fatboyslim&itemimageurl=/img/covers/fatboyslim.jpg&userid=24EH1723322222A3&sessionid=F3D4E3BE31EE3FA069F5434DB7EC2E34&actiontime=01_01_2009_23_59_59&itemtype=ITEM 
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-sessionid | required |session id of a user. (e.g. "F3D4E3BE31EE3FA069F5434DB7EC2E34")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-itemdescription | required | item description that is displayed when showing recommendations on your Website. (e.g. "the frog")
-itemurl | required | url that links to the item page on your Website.
Note:Please encode &'s in url with %26
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-itemimageurl | optional | An optional item image url that links to a image of the item.
Note:Please encode &'s in url with %26
-actiontime | optional; default: the current system time | An optional action time parameter that overwrites the current timestamp of the action. The parameter has the format "dd_MM_yyyy_HH_mm_ss" (e.g."01_01_2009_23_59_59").
-itemtype | optional; default:ITEM |An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.). If not supplied the default value ITEM will be used.
-actioninfo | optional | an arbitraray valid JSON object with additional information about he action. The JSON string may be up to **500** characters long.
-
-
+[ActionAPI]
 # Getting Recommendations
-## other users also viewed
-Users who viewed the specified item also viewed the returned items. At most 15 items are returned, results are sorted by relevance. 
-
-### Sample call
-**HTTP GET**
-
-> {*yourServerURL*}/api/1.1/otherusersalsoviewed?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional | An optional parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
-withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
-
-## other users also bought
-Users who bought the specified item also bought the items returned by this method. At most 15 items are returned, results are sorted by relevance.
-
-### Sample call
-**HTTP GET**
-
-> {*yourServerURL*}/api/1.1/otherusersalsobought?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional | An optional parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
-withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
-
-## items rated good by other users
-Users who rated the specified item 'good' did the same with items returned by this method. At most 15 items are returned, results are sorted by relevance.
-
-### Sample call
-**HTTP GET**
-
-> {*yourServerURL*}/api/1.1/itemsratedgoodbyotherusers?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional | An optional parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
-withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
-
-## related items
-This API is used to return rules generated by easyrec Plugins. At most 15 items are returned, results are sorted by relevance.
-
-### Sample call
-**HTTP GET**
-
-> {*yourServerURL*}/api/1.1/relateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&itemid=42&userid=24EH1723322222A3&itemtype=ITEM&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-userid | optional | An optional anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional | An optional parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | An optional item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | An optional type of an item (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
-withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
-
-## recommendations for user
-This recommendation shows items for a given user id. The latest items that where viewed by the given user are used to find related items of any association type (also viewed, bought, etc., but also custom assoc type). If a user has no viewing history or the viewed items have no related items an empty list is returned. You might want to display other recommendations like most viewed items or most bought items of the last week to the user instead. At most 15 items are returned, results are sorted by relevance.
-
-### Sample call
-**HTTP GET**
-
-{*yourServerURL*}/api/1.1/recommendationsforuser?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&userid=24EH1723322222A3&requesteditemtype=ITEM 
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-itemid | required | id to identify an item on your Website. (e.g. "ID001")    
-userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional | parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used. 
-withProfile | optional | If this parameter is set to true the result contains an additional element 'profileData' with the item profile.
-
-## action history for user
-This API is used to return the last actions performed by a user and can be used to present a browsing history for a user in a store.
-
-### Sample call
-**HTTP GET**
-
-{*yourServerURL*}/api/1.1/actionhistoryforuser?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&userid=24EH1723322222A3
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
-numberOfResults | optional |parameter to determine the number of results returned.
-itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-actiontype | optional | thte type of actions in the history 
-
-# Rankings
-## most viewed items
-This community ranking shows items that were viewed most by all users. 50 items are returned at most, results are sorted by relevance. 
-
-### Sample call
-** HTTP GET**
-
-{*yourServerURL*}/api/1.1/mostvieweditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-numberOfResults | optional |parameter to determine the number of results returned.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
-clusterid | optional | the type of actions in the history 
-
-
-## most bought items
-
-This community ranking shows items that were bought the most. No more than 50 items are returned, results are sorted by relevance. 
-
-### Sample call
-** HTTP GET**
-
-{*yourServerURL*}/api/1.1/mostboughtitems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
-
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-numberOfResults | optional |parameter to determine the number of results returned.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
-clusterid | optional | the type of actions in the history
-
-## most rated items
-
-This community ranking shows items that were rated the most. No more than 50 items are returned, results are sorted by relevance. 
-
-### Sample call
-** HTTP GET**
-
-{*yourServerURL*}/api/1.1/mostrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-numberOfResults | optional |parameter to determine the number of results returned.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
-clusterid | optional | the type of actions in the history 
-
-## best rated items
-
-This community ranking shows the best rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value greater than 5.5. No more than 50 items are returned, results are sorted by relevance. 
-
-### Sample call
-** HTTP GET**
-
-{*yourServerURL*}/api/1.1/bestrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-numberOfResults | optional |parameter to determine the number of results returned.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
-clusterid | optional | the type of actions in the history 
-
-## worst rated items
-
-This community ranking shows the worst rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value less than 5.5. No more than 50 items are returned, results are sorted by relevance.
-
-### Sample call
-** HTTP GET**
-
-{*yourServerURL*}/api/1.1/worstrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
-### Parameters
-parameter | occurence | description
-----------|-----------|------------
-apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
-tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
-numberOfResults | optional |parameter to determine the number of results returned.
-requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
-clusterid | optional | the type of actions in the history 
+[RecommendationAPI]
+# Community Rankings
+[RankingsAPI]

 # Profile API
-
+[ProfileAPI]
 # Import and other functions
+[ImportAPI]

 To use the Import API, the Security Token (e.g. b08f41cfa92b430538146cf474116c6d), which is generated as soon you sign in, has to be used in every Import API call. You can copy the Token form the section on the left under the API key or you can retrieve the Token from 
 > [webapp path]/operator/signin?operatorId=USER&password=PASSWORD

API modified by Stephan Zavrel

Stephan Zavrel — Tue, 04 Aug 2015 13:15:13 -0000

--- v14
+++ v15
@@ -324,6 +324,7 @@
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
 withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 
+
 # Profile API

 # Import and other functions

API modified by Stephan Zavrel

Stephan Zavrel — Mon, 03 Aug 2015 16:09:42 -0000

--- v13
+++ v14
@@ -248,11 +248,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
-* DAY: most viewed items within the last 24 hours. 
-* WEEK: most viewed items within the last week. 
-* MONTH: most viewed items within the last month. 
-* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history

@@ -272,11 +268,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
-* DAY: most viewed items within the last 24 hours. 
-* WEEK: most viewed items within the last week. 
-* MONTH: most viewed items within the last month. 
-* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history

 ## most rated items
@@ -294,11 +286,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
-* DAY: most viewed items within the last 24 hours. 
-* WEEK: most viewed items within the last week. 
-* MONTH: most viewed items within the last month. 
-* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 

 ## best rated items
@@ -316,11 +304,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
-* DAY: most viewed items within the last 24 hours. 
-* WEEK: most viewed items within the last week. 
-* MONTH: most viewed items within the last month. 
-* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 

 ## worst rated items
@@ -338,11 +322,7 @@
 tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 numberOfResults | optional |parameter to determine the number of results returned.
 requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
-withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
-* DAY: most viewed items within the last 24 hours. 
-* WEEK: most viewed items within the last week. 
-* MONTH: most viewed items within the last month. 
-* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values:  *DAY*: most viewed items within the last 24 hours. *WEEK*: most viewed items within the last week. *MONTH*: most viewed items within the last month. *ALL* (default): if no value or this value is given, the most viewed items of all time will be shown
 clusterid | optional | the type of actions in the history 
 # Profile API

API modified by Stephan Zavrel

Stephan Zavrel — Mon, 03 Aug 2015 15:55:50 -0000

--- v12
+++ v13
@@ -224,6 +224,8 @@
 ### Parameters
 parameter | occurence | description
 ----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
 userid | optional | anonymised id of a user. (e.g. "24EH1723322222A3")
 numberOfResults | optional |parameter to determine the number of results returned.
 itemtype | optional; default: ITEM | item type that denotes the type of the item (e.g. IMAGE, VIDEO, BOOK, etc.) you are looking for. If not supplied the default value ITEM will be used.
@@ -231,7 +233,117 @@
 actiontype | optional | thte type of actions in the history

 # Rankings
-
+## most viewed items
+This community ranking shows items that were viewed most by all users. 50 items are returned at most, results are sorted by relevance. 
+
+### Sample call
+** HTTP GET**
+
+{*yourServerURL*}/api/1.1/mostvieweditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+numberOfResults | optional |parameter to determine the number of results returned.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
+* DAY: most viewed items within the last 24 hours. 
+* WEEK: most viewed items within the last week. 
+* MONTH: most viewed items within the last month. 
+* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+clusterid | optional | the type of actions in the history 
+
+
+## most bought items
+
+This community ranking shows items that were bought the most. No more than 50 items are returned, results are sorted by relevance. 
+
+### Sample call
+** HTTP GET**
+
+{*yourServerURL*}/api/1.1/mostboughtitems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
+
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+numberOfResults | optional |parameter to determine the number of results returned.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
+* DAY: most viewed items within the last 24 hours. 
+* WEEK: most viewed items within the last week. 
+* MONTH: most viewed items within the last month. 
+* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+clusterid | optional | the type of actions in the history
+
+## most rated items
+
+This community ranking shows items that were rated the most. No more than 50 items are returned, results are sorted by relevance. 
+
+### Sample call
+** HTTP GET**
+
+{*yourServerURL*}/api/1.1/mostrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+numberOfResults | optional |parameter to determine the number of results returned.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
+* DAY: most viewed items within the last 24 hours. 
+* WEEK: most viewed items within the last week. 
+* MONTH: most viewed items within the last month. 
+* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+clusterid | optional | the type of actions in the history 
+
+## best rated items
+
+This community ranking shows the best rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value greater than 5.5. No more than 50 items are returned, results are sorted by relevance. 
+
+### Sample call
+** HTTP GET**
+
+{*yourServerURL*}/api/1.1/bestrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+numberOfResults | optional |parameter to determine the number of results returned.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
+* DAY: most viewed items within the last 24 hours. 
+* WEEK: most viewed items within the last week. 
+* MONTH: most viewed items within the last month. 
+* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+clusterid | optional | the type of actions in the history 
+
+## worst rated items
+
+This community ranking shows the worst rated items. Rating values range from 1 to 10. The ranking only includes items that have an average ranking value less than 5.5. No more than 50 items are returned, results are sorted by relevance.
+
+### Sample call
+** HTTP GET**
+
+{*yourServerURL*}/api/1.1/worstrateditems?apikey=8ab9dc3ffcdac576d0f298043a60517a&tenantid=EASYREC_DEMO&timeRange=ALL&requesteditemtype=ITEM
+### Parameters
+parameter | occurence | description
+----------|-----------|------------
+apikey | required | API Key to access this service.(e.g. "8ab9dc3ffcdac576d0f298043a60517a")
+tenantid | required | tenant id to identify your Website. (e.g. "EASYREC_DEMO")
+numberOfResults | optional |parameter to determine the number of results returned.
+requesteditemtype | optional; default: ITEM | item type (e.g. IMAGE, VIDEO, BOOK, etc.) to filter the returned items. If not supplied the default value ITEM will be used.
+withProfile | optional | parameter to determine the time range. This parameter may be set to one of the following values: 
+* DAY: most viewed items within the last 24 hours. 
+* WEEK: most viewed items within the last week. 
+* MONTH: most viewed items within the last month. 
+* ALL (default): if no value or this value is given, the most viewed items of all time will be shown
+clusterid | optional | the type of actions in the history 
 # Profile API

 # Import and other functions