Configuration: IKON Friends and Family

1 Setup Checklist
- 1.1 1. Infrastructure Tasks
- 1.2 2. Commerce Tasks
2 Prerequisite Tasks
- 2.1 Infrastructure Tasks
- 2.2 Commerce Tasks
3 Detailed Setup Guide
- 3.1 1. Set up Products
- 3.2 2. Configure IKON Friends and Family Plugin

Setup Checklist

1. Infrastructure Tasks

1. Infrastructure Tasks
Work with your Aspenware representative obtain Client ID and Secret IDs from Alterra Required Your representative will need the following information for testing and implementation (Note: Alterra does not support UAT credentials for all resorts so testing may be done using production credentials and provided test accounts): Resort name Test email addresses (that can receive emails) Resort callback URLs (your PDP URL, test, and production)	Prerequisite
2. Commerce Tasks
Work with your Aspenware Representative to install and enable the IKON Friends & Family Plugin. Required	Prerequisite
Set up products in Aspenware Commerce. Required Set up the product as you would normally. 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. Configure Ikon Friends & Family Plugin required On General tab (first tab) enter: The two-letter abbreviation for your resort Leave Logo Image URL as is, this image is hard-coded. Select Save. On 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. Go to the Ikon Login Configuration (third tab) and enter: Enter the appropriate URL or endpoint as follows: Login Domain: https://account.ikonpass.com Login Endpoint: /login Go to the Ikon Entitlement API Configuration (fourth tab) and enter values obtained from your Aspenware representative, while blackout dates will change according to year and pass type. Go to the Ikon Redemption API Configuration tab (fifth tab) and enter the required values. Go to the Styling tab (sixth tab) and complete required configuration (detailed below)	Detailed Setup

Prerequisite Tasks

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

Obtain the following information from your Aspenware representative:
1. Client IDs and Secrets (unique per resort)
  1. Entitlements Client ID
  2. Entitlements Client Secret
  3. Redemption Client ID
  4. Redemption Client Secret
2. Resort Abbreviation
Send the following information to your Aspenware representative for test and production:
1. Resort name
2. Test email addresses (that can receive emails)
3. 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
1. 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.
Click to enlarge the image.

Detailed Setup Guide

NOTE: For resorts using a multistore nopCommerce environment, the IKON Friends and Family component must be set up separately via the URL for the specific resort. Do this by inputting product IDs and each configuration tab (including styles) separately per resort.

1. Set up Products

Set up the product(s) that will be used for the Ikon Friends & Family component. To do this:
1. Set up the product as you would normally. (See Configure Products for basic product setup.)
2. 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.
3. 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.
1. Under the General tab enter the two-letter abbreviation for your resort (if you do not know this abbreviation contact your Ikon pass representative).
2. Under the General tab, you will see the Logo Image URL, leave as is
  1. Note that currently, this image is hard-coded.
3. Select Save.
Go to the Language tab (second tab).
1. 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.
2. Select Save.

Go to the Ikon Login Configuration (third configuration tab).
1. Enter the appropriate URL or endpoint as follows:
  1. Login Domain: https://account.ikonpass.com
  2. Login Endpoint: /login
  3. Redirect URI:
    1. https://[shop.resort.com]/ikon-friends-and-family/login-callback (insert resort name where brackets are)
      1. Example: https://shop.aspenware.com/ikon-friends-and-family/login-callback
2. Select Save.

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.
1. Entitlements API domain: https://api.ikonpass.com
2. Entitlements Client ID: Value provided by Ikon Pass to your Aspenware representative
3. Entitlements Client Secret: Value provided by Ikon Pass to your Aspenware representative
4. Entitlements Token Endpoint: /token
5. Entitlements Vouchers Endpoint: /v2/available-vouchers
  1. 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.
6. Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass.
7. Ikon Pass Blackout Dates: This number is provided by Ikon Pass.
8. Ikon Base Plus Pass Entitlement Type ID: These numbers are provided by Ikon Pass. Note that each pass will have multiple comma-separated numbers to enter into this type field.
9. Ikon Base Plus Pass Blackout Dates: This number is provided by Ikon Pass.
10. Ikon Base Pass Entitlement Type ID: This number is provided by Ikon Pass.
11. Ikon Base Pass Blackout Dates: This number is provided by Ikon Pass.
12. Ikon Local Pass Entitlement Type ID: This number is provided by Ikon Pass. Leave blank if you are not an IKON Local Resort.
13. Ikon Local Pass Blackout Dates: Enter your local resort’s blackout dates. Leave blank if you are not an IKON Local Resort.

Go to the Ikon Redemption API Configuration tab (fifth configuration tab).

Redemption Api Domain: https://entitlementapi.ikonpass.com
Redemption Token Api Domain: https://identityapi.ikonpass.com
Redemption Client Id: Value provided by Ikon Pass to your Aspenware representative (unique per resort).
Redemption Client Secret: provided by Ikon Pass to your Aspenware representative (unique per resort)
Redemption Token Endpoint: /connect/token
Redemption Single Voucher Endpoint: /v1/redemptions/manual
1. 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)

As you can see above, the component is broken down into 4 modules. Resorts may replace any portion with transparent background .png that roughly follows the guidelines above. Images outside of these guidelines will auto-size 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 that the image below is the proper size, has a transparent background, and is 255.8KB.
1. Once uploaded find the image in the RoxyFile list
2. Select image and select Preview.
3. Example image to be uploaded:
4. Copy the URL in your browser window.
5. Go to the configuration tab and paste the proper URL in the appropriate Styling tab input field.
Work with your Aspenware Representative to confirm images used are IKON approved prior to completing set up.