Don't miss out Virtual Happy Hour this Friday (April 26).

Try our conversational search powered by Generative AI!

Loading...
Area: Optimizely Product Recommendations
Applies to versions: v1.4

JavaScript API Migration notes (v1.3 to v1.4)

Recommended reading 

The following is a list of the changes between v1.3 and v1.4 of the Javascript API.

JavaScript API v1.4 replaces email address with a pseudonymized user ID in the tracking request.

Contact Episerver to use JavaScript API v1.4.

PeeriusCallbacks variable

You must add an additional parameter to the PeeriusCallback object. The parameter name is apiVersion and the value for API v.1.4 is v1_4. This overrides the default (v1.3) version 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

For Recommendations: To prevent user behavior from being lost, you need to send us 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.

For 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 will need to create a new placeholder (mail merge variabe) that represents the pseudonymized user ID. You will then need to replace the email address placeholder from all your Mail campaigns with this new placeholder.

For Triggers: Your ESP needs to be able to 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 allows Episerver to call methods that accept the pseudonymized user ID instead of email address. Also, you will need to provide and maintain a mapping between pseudonymized user ID and customer email address that your ESP can use to lookup, in order to send the email to the appropriate customer based on their pseudonymized user ID.

For 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.

Additional topics

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

Last updated: May 23, 2018

Recommended reading