Loading...
Area: Episerver Product Recommendations
Applies to versions: 1.3-1.4 (Server-to-Server API)
Other versions:

Migrating Server-to-Server API version 1.3 to 1.4

Recommendations [hide]

The following is a list of the changes between versions 1.3 and 1.4 of the Server-to-Server API, used for personalization features in Episerver.

Request message reference

To use version 1.4, you need to specify the correct version number in the request URL, as shown in the following example.

https://<clientname>.peerius.com/tracker/api/v1_4/rest.pagex

Tracking request

IP address

Sending the ip address is optional in the tracking request, as shown in the following example.

"ip": "10.42.37.139"

User ID

Server-to-Server API version 1.4 replaces email addresses with a pseudonymized user ID.

A user’s email and name are removed from the tracking request, as shown in the following examples.

"user" : { 
           "name"  : "john.customer@email.com", 
           "email" : "john.customer@email.com" 
         }

They are replaced by a pseudonymized user id:

"user" : { 
           "id" : "abcd1234efgh" 
         }

Session ID and CUID

The format of session and cuid was changed from v1.3 to v1.4.

The forward slash (/) in their values in v1.3...

"session" : "155780550/hKugo5RQsqecUpmlWE6EpFWqmalVrJU",
"cuid"    : "143159800/hKugo5RQsqecUpmlWE6Eo1OklrJYp5U"

...was changed to a pipe (|) in v1.4.

"session" : "123456789012|a1b2c3d4e5A6B7C8D9E0f1g2h3i4j5F1G2H3I4J5k1l",
"cuid"    : "09876543210|Z0Y9X8W7V6z5y4x3w2v1U0T9S8R7Q6u5t4s3r2q1P0O"

Notes

Product Recommendations. To prevent user behavior from being lost, send Episerver an up-to-date mapping between email addresses and pseudonymized user IDs. Provide this once so that Episerver Personalization can replace existing customer email addresses with their corresponding pseudonymized user ID.

Email Product Recommendations. Provide an up-to-date mapping between email addresses and pseudonymized user IDs to your Email Service Provider (ESP) . Your ESP should create a new placeholder (mail merge variable) that represents the pseudonymized user ID. Then you replace the email address placeholder from all your Mail campaigns with this new placeholder.

Triggered Messages. Your ESP must handle pseudonymized user IDs. Currently, in Triggered Messages, this functionality is provided only by Episerver Campaign. Ask your ESP to provide an API extension that lets Episerver call methods that accept the pseudonymized user ID instead of email address. Also, provide and maintain a mapping between pseudonymized user ID and customer email address that your ESP can use to lookup, to send the email to the appropriate customer based on their pseudonymized user ID.

Promote. If provided, Episerver Personalization can use the visitor's IP address, within their session, to do a geolocation lookup to identify the approximate location of the visitor for a personalized online experience. IP addresses if provided will no longer be stored, so cannot be used for analytics and reporting.

Related topics

Do you find this information helpful? Please log in to provide feedback.

Last updated: May 23, 2018

Recommendations [hide]