HTML Integration: Home Page (Legacy)
NOTE This section refers to a legacy feature which is only available to existing customers. New and existing customers looking to add personalization should refer to Home Page (JSON).
The home page is typically a generic page that does not have a specific product or product category associated to it.
How To Make This Code Work For You
Follow the sample integration code below, making these changes:
Function | Requirement | ||
R3_COMMON.setApiKey('MY_API_KEY'); |
Replace MY_API_KEY with your site’s API key, a unique identifier for your account. |
||
R3_COMMON.setBaseUrl(RRSERVER_URL); |
Set RRSERVER_URL to one of these values:For initial development:
For production:
|
||
R3_COMMON.setSessionId('USER_SESSION_ID'); |
Replace USER_SESSION_ID with the session ID for the current user and session. The session ID is a crucial variable that allows Algonomy to track shopper behavior when they visit your site so recommendations can be generated. This parameter should remain the same from start to finish for a user’s shopping session. |
||
R3_COMMON.setUserId('USER_ID'); |
Replace Note: if the USER_ID is unknown, leave it blank. |
||
R3_COMMON.setClickthruServer(window.location.protocol+'//'+window.location.host) |
No changes are required. This code enables the client to send the domain for click-through URL through the p13n_generated.js call if relative URLs are supplied in the feed. For example, if the domain calling our code is m.retailer.com or UAT.retailer.com, we can automatically redirect to the correct domain. |
Sample Integration Code
Primary Code Block
<!-- Place this code inside the <body> element as close to the top as possible --> < script src = "//media.richrelevance.com/rrserver/js/1.2/p13n.js" ></ script > < script charset = "utf-8" type = "text/javascript" > var R3_COMMON = new r3_common(); R3_COMMON.setApiKey('abcd5432e1'); R3_COMMON.setBaseUrl(window.location.protocol+'//integration.richrelevance.com/rrserver/'); R3_COMMON.setClickthruServer(window.location.protocol+"//"+window.location.host); R3_COMMON.setSessionId('6B4D397B'); R3_COMMON.setUserId('1'); // if no user ID is available, please leave this blank // here's an example requesting recommendations for 3 page areas R3_COMMON.addPlacementType('home_page.rr1'); R3_COMMON.addPlacementType('home_page.rr2'); R3_COMMON.addPlacementType('home_page.rr3'); var R3_HOME = new r3_home(); r3(); </ script > |
Placement-marker Code Blocks
< script charset = "utf-8" type = "text/javascript" > r3_placement('home_page.rr1'); </ script > <!-- Page contents --> < script charset = "utf-8" type = "text/javascript" > r3_placement('home_page.rr2'); </ script > <!-- Page contents --> < script charset = "utf-8" type = "text/javascript" > r3_placement('home_page.rr3'); </ script > |
Flush Code Block
< script charset = "utf-8" type = "text/javascript" > rr_flush_onload(); </ script > |
Notes
- The values in
addPlacementType()
should match the values in eachr3_placement()
call.