About APSIS One's Episerver Integration
"Our mission is to make it easy for customers to create effective digital experiences for their customers - in any channel and on any device."
Read more on Episerver's website.
The APSIS Episerver Plugin enables Episerver editors to use Segments created in APSIS One for personalisation rules. Segments are created and maintained in APSIS One and automatically transferred to Episerver so that they can be used in combination with other conditions.
Here's a summary of the process of integrating Episerver with your APSIS One account. Click to jump right to a section in the article for a more detailed run-down.
You will need an API Key in order to integrate Episerver with you APSIS One account, and a WebAdmin role to set up the APSIS One Episerver plugin.
1. Install Episerver from an installation file from your APSIS One account manager.
2. Set up the Episerver plugin.
3. Create Visitor Groups, from Segments created with the APSIS One Segment Builder.
This version of the APSIS One Episerver plugin is compatible with Episerver CMS 11 and all later versions, and requires .NET framework 4.6.2.
Make sure that your user has a WebAdmin role to set up the APSIS One Episerver plugin after the installation.
The request limit for the Episerver plugin is 250 APSIS One API requests per second.
The package will install the following files:
The package also adds a localisation provider to web.config:
<add virtualPath="~/lang" name="LocalizationFiles" type="EPiServer.Framework.Localization.XmlResources.FileXmlLocalizationProvider, EPiServer.Framework.AspNet" />
Enable Episerver in APSIS One
Install the Apsis.One.Episerver NuGet package and follow the instructions in the installation setup. Your APSIS Account Manager will provide you with an installation file.
Setting up the Episerver Plugin
Once the installation of the Episerver plugin is complete, a new tool will be available in the Episerver Admin mode for APSIS One settings.
To access this page, make sure that your user has a WebAdmin role.
1. Head to the Admin tab in your Episerver account.
2. Click on APSIS One Settings in the Tools menu, on the left.
3. Enter your details to integrate Episerver with APSIS One:
Enable: Enable or disable the APSIS One plugin. Check the box to continue.
API URI*: The base API address. Must be a valid URI. Enter the domain name: https://api.apsis.one/
Client ID*: Your API Client Id.
Client Secret*: Your API Client Secret.
Timeout*: Timeout for API requests in milliseconds. Limited by range [1;600000]. Use a reasonable timeout value.
API request limit: Set the upper bound of the API calls amount per second (250 maximum).
Cookie Name*: The cookie name that contains APSIS One Profile Key.
Time Zone: The time zone to use with APSIS API calls.
All items marked with an asterisk (*) are mandatory.
4. Click Save.
Creating Episerver Visitor Groups
You can tailor or personalise the content of your website for specific visitors (Profiles) by creating visitor groups in Episerver.
To manage visitor groups on the Episerver plugin, you'll need a WebEditor role.
In the Episerver plugin, visitor groups are made with Segments, created with the Segment Builder in Audience. Read more about Segmentation...
You can match a visitor group to one or more APSIS One Segments. Head over to the Visitor Groups tab in Episerver to begin.
1. On the right side, under APSIS One Segment Criteria, drag and drop the Segment element into the Criteria row.
2. Choose a match type:
Match Any: The visitor's Profile must match at least one of the chosen Segments.
Match All: The visitor's Profile must match all the chosen Segments.
Please consider that choosing all or any when working with Segments will interact with the included and/or excluded conditions in your Segment. Jump to Working with Segments...
4. Select the segment(s) you wish to add as a Segment Criteria.
3. You may continue to add as many Segment Criterion as needed by repeating the process described above.
Pay close attention to the match type on the top right, which will affect the way the Segments relate with each other and ultimately the content shown on your website for different Profiles.
4. When done, click Save.