diff --git a/docs/personalization/enable_personalization.md b/docs/personalization/enable_personalization.md index 13a74fe53e..0e6b302683 100644 --- a/docs/personalization/enable_personalization.md +++ b/docs/personalization/enable_personalization.md @@ -14,7 +14,7 @@ instance must [request access to the service]([[= user_doc =]]/personalization/e ## Set up customer credentials When you receive the credentials, add them to your configuration. -In the root folder of your project, edit either the `.env` or `.env.local` file +In the root folder of your project, edit the `.env.local` file by adding the following lines with your customer ID and license key: ``` @@ -23,7 +23,7 @@ PERSONALIZATION_LICENSE_KEY=67890-1234-5678-90123-4567 PERSONALIZATION_HOST_URI=https://server_uri ``` -!!! note "Configuring user credentials for different customers" +!!! note "Configuring user credentials for multisite setup and different personalization customers" If your installation [hosts multiple sites]([[= user_doc =]]/personalization/use_cases/#multiple-website-hosting) with different customer IDs, for example, to provide separate recommendations for different @@ -140,6 +140,9 @@ ibexa: content: use_remote_id: true ``` +!!! note "Support for alphanumeric content identifier" + + Contact support@ibexa.co with your organization's requirements to have the alphanumeric content identifier enabled. #### Enable tracking @@ -437,8 +440,8 @@ if the content Fields were previously exported by the export script. "itemType": 38, "relevance": 3, "links": { - "clickRecommended": "//event.test.perso.ibexa.co/api/723/clickrecommended/someuser/38/71?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736", - "rendered": "//event.test.perso.ibexa.co/api/723/rendered/someuser/38/71?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736" + "clickRecommended": "//event.perso.ibexa.co/api/723/clickrecommended/someuser/38/71?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736", + "rendered": "//event.perso.ibexa.co/api/723/rendered/someuser/38/71?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736" }, "attributes": [ { @@ -472,8 +475,8 @@ if the content Fields were previously exported by the export script. "itemType": 38, "relevance": 1, "links": { - "clickRecommended": "//event.test.perso.ibexa.co/api/723/clickrecommended/someuser/38/75?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736", - "rendered": "//event.test.perso.ibexa.co/api/723/rendered/someuser/38/75?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736" + "clickRecommended": "//event.perso.ibexa.co/api/723/clickrecommended/someuser/38/75?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736", + "rendered": "//event.perso.ibexa.co/api/723/rendered/someuser/38/75?scenario=popular&modelid=4199&categorypath=&requestuuid=d75e7cf0-e4ca-11e7-a94d-0a64dbbea736" }, "attributes": [ { diff --git a/docs/personalization/integrate_recommendation_service.md b/docs/personalization/integrate_recommendation_service.md index 372017f63d..847f89ef18 100644 --- a/docs/personalization/integrate_recommendation_service.md +++ b/docs/personalization/integrate_recommendation_service.md @@ -22,7 +22,7 @@ The easiest way of embedding the tracking URL is placing a one pixel image on ev like in the case of analytical tools or visitor counters. A code that includes an image looks like this: -`` +`` where: @@ -39,9 +39,10 @@ PHP: ``` php $mandator_id = '00000'; +$content_type_id = '1'; $product_id = '123'; $server = '//event.perso.ibexa.co'; -$tracking = $server.'/ebl/'.$mandator_id.'/click/'.urlencode(session_id()).'/1/'.$product_id; +$tracking = $server.'/api/'.$mandator_id.'/click/'.urlencode(user_id()).$content_type_id.$product_id; echo ""; ``` @@ -49,9 +50,10 @@ JavaScript: ``` js var mandator_id = '00000'; +var content_type_id = '1'; var product_id = '123'; var server = '//event.perso.ibexa.co'; -var url = server + '/api/' + mandator_id + '/click/' + getSessionId() + '/1/' + product_id; +var url = server + '/api/' + mandator_id + '/click/' + getUserId() + content_type_id + product_id; var ycimg=new Image(1,1); ycimg.src=url; ``` @@ -61,7 +63,7 @@ A similar tracking image can be placed on a confirmation page that ends the paym ``` php $server = '//event.perso.ibexa.co'; foreach ($just_bought_products as $product_id) { - $tracking = $server.'/ebl/'.$mandator_id.'/buy/'.urlencode(session_id()).'/1/'.$product_id; + $tracking = $server.'/api/'.$mandator_id.'/buy/'.urlencode(user_id()).$content_type_id.$product_id; echo "\n"; } ``` @@ -128,7 +130,7 @@ $mandator_id = '00000'; $license_key = '67890-1234-5678-90123-4567'; $server = "https://reco.perso.ibexa.co"; $scenario = "category_page"; -$url = $server.'/ebl/00000/'.urlencode(session_id()).'/'.urlencode($scenario).'.json'; +$url = $server.'/api/v2/00000/'.urlencode(user_id()).'/'.urlencode($scenario).'.json'; $curl = curl_init(); $request = array( diff --git a/docs/personalization/tracking_integration.md b/docs/personalization/tracking_integration.md index 7d572bda6f..2c450bda93 100644 --- a/docs/personalization/tracking_integration.md +++ b/docs/personalization/tracking_integration.md @@ -11,7 +11,7 @@ where the event must be sent [pixel tracking](integrate_recommendation_service.m For example, with HTML:  ``` html - + ``` or with JavaScript: @@ -19,7 +19,7 @@ or with JavaScript: ``` js ``` diff --git a/docs/personalization/tracking_with_ibexa-tracker.md b/docs/personalization/tracking_with_ibexa-tracker.md index 13e453e1dd..883552950d 100644 --- a/docs/personalization/tracking_with_ibexa-tracker.md +++ b/docs/personalization/tracking_with_ibexa-tracker.md @@ -9,8 +9,8 @@ JavaScript in your site. The approach is very generic and evaluate it if it meets your **requirements and security policy**. -If you want the `userid` to be generated automatically, leave out the user -params in the `_ycq.push` calls. +If you want the `userid` to be generated automatically, set user +parameter as empty `''` in the `_ycq.push` calls. If a predefined cookie already exists, it is used. Otherwise a new one is created. @@ -32,7 +32,7 @@ the closing `` tag.