This guide will review how to set up Ikon Pass Friends & Family in Aspenware Commerce. For more information general product setup (including discounts and hidden categories) see Configuring Products in the Aspenware Commerce Documentation or for general release notes, see {Link to Release Notes}.
Overview
The Ikon Pass Friends & Family plugin allows passholders - and those with whom passholders share their Friends & Family tickets - to redeem their discounted tickets via the Aspenware Commerce platform. Those resorts that have purchased the plugin and installed it following the directions below will be able to display the Ikon Friends & Family component on the discounted ticket PDP. Guests will use this component to log into their Ikon Pass account and be immediately returned to the PDP where any relevant entitlements will display on the right side of the component. Guests will then be able to add tickets to their cart according to the number of entitlements they have. Adding to cart decrements available entitlements visually and prevents guests from adding more entitlements than are shown. Once a purchase is complete entitlements are updated/deducted in the Alterra database. The “log out” button will log the guest out of their Ikon pass account within Aspenware Commerce and any other tab open on the browser. This allows guests to log into a different account if needed. Finally, for families with linked accounts (referred to as “participants” in Ikon), the head account holder will be able to see and use an aggregate of all Friends & Family tickets in the household.
Key Terms
Resort Abbreviation
Each resort that has some passholder relationship with Ikon has an abbreviation. This two-letter abbreviation will be used by Alterra to retrieve the relevant entitlements for the logged-in guest.
Dev Mode
Dev mode allows test users to see guest entitlement with more detail. This is not meant to be used in a production environment and should be unchecked when in production.
Feature Detail
Descriptions and images
Feature Detail Header 1
Paragraph
Feature Detail Header 2
Paragraph
Configuration Guide
Prerequisite Steps
POS Tasks
Infrastructure Tasks
Alterra must whitelist all resort IP addresses prior to component working Leigh Bush - create meeting to align
Determing client ID and Secret
Leigh Bush How to request from Alterra, all the needs for them to whitelist- what else needs to be specified
Commerce Tasks
Settings, Language Strings, and HTML Widgets
Detailed Setup Guide
Install the IKON Friends & Family Plugin
Go to > Aspenware Commerce > Configuration > Local Plugins
Locate “IKON Friends & Family” under the Aspenware Group and select Install.
Once installed Enable the plugin by selecting Edit next to the listed plugin and ensure the Is enabled checkbox is selected.
Now that the plugin is ready to be configured, ensure that you have the product set up that will be used for the Ikon Friends & Family component. To do this:
Set up the product as you would normally. (See Configuring Products for basic product setup.)
Note the product ID in the URL on the product configuration page.
Copy the product ID and add it to the Product ID field in Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family
Go back to the plugin (Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family) and select Configure.
Under the General tab enter the two-letter abbreviation for your resort (if you do not know this abbreviation contact your Ikon pass representative).
(note to documents and service: currently this image is hard-coded, and may be removed for the deploy - regardless, no matter what is put there nothing changes)
Select Save.
Go to the Language tab (second tab)..
Enter the language you would like to appear in the bottom “toast” message when the responses noted above each text box are returned. See the example below.
Select Save.
Go to the Ikon Login Configuration (third configuration tab).
Enter the appropriate URL or endpoint as follows:
Login Domain: https://account.ikonpass.com
Login Endpoint: /login
Redirect URI: resort-pdp-url/login-callback
Select Save.
IMPORTANT: For the redirect URI be sure to enter the URL from your resort’s PDP followed by “/login-callback”. This will return the logged-in Ikon Pass guest to the appropriate page.
For example: https://myresort.com/ikon-friends-and-family-tix/login-callback
Go to the Ikon Entitlement API Configuration (fourth configuration tab).
Here you will get most values from your Ikon representative, while blackout dates will change according to year and pass type. See the image below for an example.
Entitlements API domain: https://api.ikonpass.com
Entitlements Client ID: provided by Ikon Pass
Entitlements Token Endpoint: /token
Entitlements Vouchers Endpoint: /v2/available-vouchers
Ikon Pass Entitlement Type ID: this will likely be a three-digit number provided by Ikon Pass
Ikon Pass Blackout Dates: provided by Ikon Pass
Ikon Base Plus Pass Entitlement Type ID:
Ikon Base PlusPass Blackout Dates:
Ikon Base Pass Entitlement Type ID:
Ikon Base Pass Blackout Dates:
Ikon Local Pass Entitlement Type ID: provided by Ikon Pass
Ikon Local Pass Blackout Dates:
NOTE: Blackout dates must be written in the following format mm/dd/yyyy.
Go to the Ikon Redemption API Configuration tab (fifth configuration tab).
Enter the following values in the fields (see example below):
Redemption Api Domain:
Redemption Token Api Domain:
Redemption Client Id:
Redemption Client Secret:
Redemption Token Endpoint:
Redemption Single Voucher Endpoint:
Redemption Grant Type:
Redemption Scope:
Common Troubleshooting guide
Q: Question 1
A: Answer 1