Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

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.

This guide will review how to set up Ikon Pass Friends & Family in Aspenware Commerce. For more information on general product setup (including discounts and hidden categories) see Configuring Products in the Aspenware Commerce Documentation or for general release notes, see 2.21 Release Notes.

Overview

The Ikon Pass Friends & Family plugin allows those with whom pass holders share their Friends & Family tickets to redeem their discounted tickets via the online store of the resort where the tickets will be used. Those resorts that have purchased the annual subscription for the IKON Pass discount integration and who have installed it in their Aspenware Commerce platform following the directions below will be able to display the Ikon Friends & Family component on the discounted ticket Product Detail Page (PDP).

Guests will use this component to log into their Ikon Pass account and be immediately returned to the resort store PDP where any relevant discount entitlements for that guest will display on the right side of the component. Guests will then be able to add these 20% discounted 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 available. 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 that is 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.

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.

Configuration Guide

Prerequisite Steps

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.

Infrastructure Tasks

  • Get the following information from Alterra (Steven Carrol <scarroll@alterramtnco.com>) for implementation:

    1. Client ID and Secret (unique per resort and for test vs. production)

    2. Resort Abbreviation (same in test and prod)

  • Send the following information to Alterra (Steven Carrol <scarroll@alterramtnco.com>) for testing and implementation:

    1. Resort name

    2. Test email addresses (that can receive emails)

    3. Resort callback urls (your pdp url, test and production)

Detailed Setup Guide

  • 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.

  • 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:

    1. Set up the product as you would normally. (See Configuring Products for basic product setup.)

    2. Note the product ID in the URL on the product configuration page.

    3. 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.

    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:

        1. IF test: https://account.uat.ikonpass.com

        2. IF production: https://account.ikonpass.com

      2. Login Endpoint: /login

      3. Redirect URI: [resort-pdp-url]/login-callback (see note below on how to configure)

        1. Note this will be different between test and prod and will need to be updated when copy live to tests occur.

    2. 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.

  • https://[url to your friends and family tickets here]/login-callback

  • For example: https://myresort.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.

    1. Entitlements API domain:

      1. IF test: https://api.uat.ikonpass.com

      2. IF prod: https://api.ikonpass.com

    2. Entitlements Client ID: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    3. Entitlements Client Secret: Value provided by Ikon Pass

      1. (Note that these values are different for test and production and from the redemption API.)

    4. Entitlements Token Endpoint: /token

    5. Entitlements Vouchers Endpoint: /v2/available-vouchers

    6. Ikon Pass Entitlement Type ID: This number is provided by Ikon Pass.

      1. For the 2021/2022 season, these values are in sync between test and production.

    7. Ikon Pass Blackout Dates: This number is provided by Ikon Pass.

    8. Ikon Base Plus Pass Entitlement Type ID: This number is provided by Ikon Pass.

    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.

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:

    1. IF test: https://api-central-entitlements-uat.azurewebsites.net

    2. IF prod: https://api-central-entitlements.azurewebsites.net

  • Redemption Token Api Domain:

    1. IF test: https://api-identityserver4-uat.azurewebsites.net

    2. IF prod: https://api-identityserver4.azurewebsites.net

  • Redemption Client Id: Value provided by Ikon Pass and is unique per resort.

    1. 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)

    1. 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

  1. In order to be able to 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.

  2. 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?

  1. Give Steven 48 hours to add resorts and QA accounts.


  • No labels