Setup Checklist
This section is a comprehensive and high level summary of all tasks and prerequisites required for this feature to function properly. This section is purposed for use after an administrator is familiar with configuring this feature as an “audit” checklist. For detailed set-up instructions, jump down to “Prerequisite Tasks” and “Detailed Setup Guide” and then follow up with this checklist to ensure all steps are completed.
1. Infrastructure Tasks | |
|---|---|
| PREREQUISITE |
2. Commerce Tasks | |
| PREREQUISITE |
| DETAILED SETUP |
Prerequisite Tasks
This section describes all requirements that must be completed before you can begin setting up this feature. Once these tasks are complete continue to the next section.
IMPORTANT: Enabling this feature does require an annual feature subscription fee. Talk to your Aspenware representative about adding this feature to your Aspenware Commerce subscription.
Infrastructure Tasks
Infrastructure Tasks
Obtain the following information from Alterra (Steven Carrol <scarroll@alterramtnco.com>) for implementation:
Client IDs and Secrets (unique per resort and for test vs. production)
Prod Entitlements Client ID
Test Entitlements Client ID
Prod Entitlements Client Secret
Test Entitlements Client Secret
Test Redemption Client ID
Prod Redemption Client ID
Test Redemption Client Secret
Prod Redemption Client Secret
Resort Abbreviation (same in test and prod)
Send the following information to Alterra (Steven Carrol <scarroll@alterramtnco.com>) for testing and implementation:
Resort name
Test email addresses (that can receive emails)
Resort callback URLs (your PDP URL, test, and production)
Commerce Tasks
Work with your Aspenware Representative to install the IKON Friends & Family Plugin.
IMPORTANT: Enabling this feature does require an annual feature subscription fee. Talk to your Aspenware representative about adding this feature to your Aspenware Commerce subscription.
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.
Detailed Setup Guide
1. Set up Products
Set up the product(s) 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. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.
Copy the product ID and add it to the Product ID field in Aspenware Commerce > Configuration > Local Plugins > IKON Friends & Family. Consider that this may be different between your live and test environment if not performing copy live to tests frequently.
2. Configure IKON Friends and Family Plugin
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).
Under the General tab, you will see the Logo Image URL, leave as is
Note that currently, this image is hard-coded.
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:
IF test: https://account.uat.ikonpass.com
IF production: https://account.ikonpass.com
Login Endpoint: /login
Redirect URI: [resort-pdp-url]/login-callback (see note below on how to configure)
Note this will be different between test and prod and will need to be updated when copy live to tests occur.
Select Save.
IMPORTANT: For the redirect URI, enter the URL from your resort’s PDP followed by “/login-callback” and remove the subdirectory pointing to the category. This will return the logged-in Ikon Pass guest to the appropriate page.
For Example: https://myresort.com/s/lift-tickets/p/friends-and-family-tix/
Would be entered as: https://myresort.com/friends-and-family-tix/login-callback
Go to the Ikon Entitlement API Configuration (fourth configuration tab). Most of the values will need to be obtained 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:
IF test: https://api.uat.ikonpass.com
IF prod: https://api.ikonpass.com
Entitlements Client ID: Value provided by Ikon Pass
(Note that these values are different for test and production and from the redemption API.)
Entitlements Client Secret: Value provided by Ikon Pass
(Note that these values are different for test and production and from the redemption API.)
Entitlements Token Endpoint: /token
Entitlements Vouchers Endpoint: /v2/available-vouchers
Note that this value may change as Alterra makes updates to their code. Aspenware will work closely with Alterra to stay informed of Endpoint changes.
Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass.
For the 2021/2022 season, these values are in sync between test and production.
Ikon Pass Blackout Dates: This number is provided by Ikon Pass.
Ikon Base Plus Pass Entitlement Type ID: This number is provided by Ikon Pass.
Ikon Base Plus Pass Blackout Dates: This number is provided by Ikon Pass.
Ikon Base Pass Entitlement Type ID: This number is provided by Ikon Pass.
Ikon Base Pass Blackout Dates: This number is provided by Ikon Pass.
Ikon Local Pass Entitlement Type ID: This number is provided by Ikon Pass. Leave blank if you are not an IKON Local Resort.
Ikon Local Pass Blackout Dates: Enter your local resort’s blackout dates. Leave blank if you are not an IKON Local Resort.
NOTE: Blackout dates must be written in the following format mm/dd/yyyy.
Go to the Ikon Redemption API Configuration tab (fifth configuration tab).
NOTE: The fields below will be prepopulated with default values for TEST. You will need to enter your Client ID and Secret provided by Ikon Pass and adjust the URLs when deploying to production, (see example below):
Redemption Api Domain:
Redemption Token Api Domain:
Redemption Client Id: Value provided by Ikon Pass and is unique per resort.
Note that these values are different for test and production and from the redemption API.
Redemption Client Secret: provided by Ikon Pass (Unique per resort)
Note that these values are different for test and production and from the redemption API.
Redemption Token Endpoint: /connect/token
Redemption Single Voucher Endpoint: /v1/redemptions/manual
Note this value should be stable for the 2021-22 season, but may change in the future as Alterra makes updates to their code. Aspenware will work closely with Alterra to stay informed of Endpoint changes.
Redemption Grant Type: client_credentials
Redemption Scope: write_entitlements
Redemption Type Id: 6
Go to Styling Tab (sixth configuration tab)
NOTE: The default component will look like the image below. To change the look of any portion of this component, you can upload files following the guidelines in the example image and the configuration instructions below.
As you can see above, the component is broken down into 4 modules. Resorts may replace any portion with a transparent background png that roughly follows the guidelines above. Images outside of these guidelines will autosize and, therefore, may be stretched.
To upload any of the images go to Catalog > Your Product > Email Description > Open the “Image Tab”
Select Browse, select image from desktop and upload
Note the image below is the proper size, has a transparent background, and is 255.8KB
Once uploaded find the image in the RoxyFile list
Select image and select “Preview”
Example image to be uploaded:
Copy the url in your browser window
Go to configuration tab and paste the proper url in the appropriate Styling tab input field
Sarah Holst There is a new and final Styling configuration tab that was added due to new requirements from IKON that came in last week and Aaron and Leigh accommodated for. Leigh Bush will have the details on this, essentially, our recommendation is to upload the images required to the AW Commerce Admin Image hosting service - Go to Content management>message templates> edit any template> Select Insert>Insert Image >click the file icon>Add file>Choose file. Then find the files for each image on your computer (AW can get from IKON to use as part of your implementation - must use IKON approved styling/wording/fonts/images, etc). Once uploaded, you can click on an image title and select preview to get the links, and these URLS can be plugged into the admin tab below.
Sarah Holst Another step that is only relevant to resorts that have multiple storefronts is that this is supported so that you can have unique values for this plugin for each storefront. I can’t figure out how that works, so Leigh Bush will need to provide steps/show you how.
Like this page? Click the like button below. Don't like this page and/or want to give feedback about this page, leave a comment below and Aspenware will address to improve this article.