03 Site Settings - ecellar/remote-widgets GitHub Wiki
The Designer Widgets requires a few site-specific settings that you must supply to the eCellar support team during your development cycle. Without these, you will not have a fully functional integration.
We must know the following for each of your environments: development and production:
1. The full URL for your store’s main landing page URL.
This will be used for all “Continue Shopping” links in Designer Widget views. For example:
https://<yoursite>.com/shop/?view=products&slug=current-releasesTypically this is a SPA-enabled page, but it does not have to be.
2. The default SPA instance to handle system-generated links.
This will be used for things like Password Reset links, Campaign Unsubscribe links, etc. For example:
https://<yoursite>.com/shop/Optionally, you may use different SPA instances for different system-generated links. For example, if you have one SPA instance at:
https://<yoursite>.com/shop/and another SPA instance at:
https://<yoursite>.com/account/you may want to have some/all of the system-generated links use your ‘/account/’ SPA instance. In most cases, the decision is made based on whether different SPA instances use different page wrappers in your site.
Tip: For information about setting up multiple SPA instances, visit our 05 Initialization Examples page.
Below is a table describing all system-generated links and their default URL format. If you are only using one SPA instance you do not need to know about these: our defaults will typically work fine.
If you are using more than one SPA instance or are overriding our default view names using viewAliases, you should study this list and let us know which SPA instance to use for each one and what, if any, alias you are using for the associated view.
Note: each URL includes a query string name/value pair that includes a {0} placeholder that is replaced with data from the system. Those name/value pairs may not be customized.
| Link Type | Description |
|---|---|
| PasswordReset | Sent to customers in Forgot Password emails. Customer clicks link to go to the next step of the process. Format: ?view=passwordreset&token={0} |
| Unsubscribe | Automatically placed in the footer of every campaign email. Customer may click the link if they wish to unsubscribe. Format: ?view=unsubscribe&unsubscribe_token={0} |
| WebView | Generated when your client uses the [[webview]] merge field in a campaign email. Customer may click the link to view an embedded (iframe) view of their email at your client’s site.Format: ?view=webview&campaign_token={0} |
| MagicLink | In the ACP, a client may define different kinds of Magic Links and then use them as merge fields in Campaign Emails. When a customer clicks a Magic Link a brief interstitial appears, then the customer is automatically authenticated and taken to the Magic Link’s destination. Format: ?view=magiclink&campaign_token={0} |
| DeepLink | In the ACP, a client may define different kinds of Deep Links and then use them as merge fields in Campaign Emails. When a customer clicks a Deep Link a brief interstitial appears, then the customer is taken to the Deep Link’s destination. Format: ?view=link&slug={0} |
If you are using URL Rewrites for your site, the default formats are:
PasswordReset: /passwordreset/{0}/
Unsubscribe: /unsubscribe/{0}/
WebView: /webview/{0}/
MagicLink: /magiclink/{0}/
DeepLink: /link/{0}/
You will need to be sure that these paths can operate correctly when appended to your specified SPA instance(s).