Table of Contents |
---|
Note |
---|
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. |
...
For more details on the guest flow and value of turning this feature on at your resort, please read https://hub.aspenware.net/main/Announcing-IKON-Pass-Friends-&-Family-Discount-Redemption.1980170312.html .
Key Terms
Resort Abbreviation
Each resort that has some passholder relationship with IKON Pass 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 in Aspenware Commerce test stores 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.
...
Get the following information from Alterra (Steven Carrol <scarroll@alterramtnco.com>) for implementation:
Client ID
and Secret (unique per resort and for test vs. production)
Resort Abbreviation (same in test and prod)
Send the following information to Alterra (Steven Carrol <scarroll@alterramtnco.com>) for testing and implementation:
Provide all resort IP addresses to Steven Carroll at Alterra for whitelistingResort name
Test email addresses (that can receive emails)
Resort callback urls (your pdp url, test and production)
Detailed Setup Guide
Work with your Aspenware Representative to install the IKON Friends & Family Plugin.
Note |
---|
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.
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 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.
...
Note |
---|
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.
|
Go to the Ikon Entitlement API Configuration (fourth configuration tab).
Here you will get most valuesMost 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
Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass
(DO NOT CHANGE).
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
(DO NOT CHANGE).
Ikon Base Plus Pass Entitlement Type ID: This number is provided by Ikon Pass
(DO NOT CHANGE).
Ikon Base Plus Pass Blackout Dates: This number is provided by Ikon Pass
(DO NOT CHANGE).
Ikon Base Pass Entitlement Type ID: This number is provided by Ikon Pass
(DO NOT CHANGE).
Ikon Base Pass Blackout Dates: This number is provided by Ikon Pass
(DO NOT CHANGE).
Ikon Local Pass Entitlement Type ID: This number is provided by Ikon Pass
(DO NOT CHANGE).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.
Info |
---|
NOTE: Blackout dates must be written in the following format mm/dd/yyyy. |
...
Redemption Api Domain:
IF test: https://api-central-entitlements-uat.azurewebsites.net
Redemption Token Api Domain:
Redemption Client Id: Value provided by Ikon Pass (Unique per resort)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
Redemption Grant Type: client_credentials
Redemption Scope: write_entitlements
Redemption Type Id: 6
...
Testing Notes
In order to be able to login log in to the Ikon UAT test environment, you MUST open a new tab in your browser and navigate to this URL. You do not need to do anything once you reach this page. If you do not do this step then nothing will work when testing in a non-production environment. If the link expires because it has been open too long you will also not be able to test and must reaccess the url anew.
You also may need to work with Alterra to get test accounts configured for your resort’s implementation. Provide Alterra with email addresses you would like to use and what type of entitlement you would like for that email address.
Common Troubleshooting
How much lead time will Alterra need to enable deployment to a resort from their end?
Give Steven 48 hours to add resorts and QA accounts.