Loading...
Area: Episerver Perform, Episerver Reach
Applies to versions: 1.3-1.4 (JavaScript API)

Migrating JavaScript API version 1.3 to 1.4

The following is a list of the changes between versions 1.3 and 1.4 of the Javascript API.

JavaScript API version 1.4 replaces email address with a pseudonymized user ID in the tracking request.

Contact Episerver to use JavaScript API version 1.4.

PeeriusCallbacks variable

You must add an additional parameter to the PeeriusCallback object. The parameter name is apiVersion and the value is v1_4. This overrides the default version 1.3 from the tracker script.

// this should be included in all pages
var PeeriusCallbacks=
  { 
    ...
    apiVersion="v1_4"
  }

Tracking request

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" }

Notes

Recommendations. To prevent user behavior from being lost, you need to send Episerver an up-to-date mapping between email addresses and pseudonymized user IDs. This only needs to be provided once so that Episerver Personalization can replace existing customer email addresses with their corresponding pseudonymized user ID.

Mail. You need to continually provide your ESP (Email Service Provider) an up-to-date mapping between email addresses and pseudonymized user IDs. Your ESP needs to create a new placeholder (mail merge variable) that represents the pseudonymized user ID. You then replace the email address placeholder from all your Mail campaigns with this new placeholder.

Triggers. Your ESP must handle pseudonymized user IDs. Currently, in Triggers, this functionality is provided only by Episerver Campaign. Alternatively, you need to advise 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

Last updated: May 23, 2018