Difference between revisions of "NATS4 Upsell Plus"
From TMM Wiki
Jump to navigationJump to searchTmm vincent (talk | contribs) (revised wording & formatting of article, removed extra wiki links, updated auth string section to use Config Admin instead of manual editing, and changed example URLs from http to https) |
|||
| Line 3: | Line 3: | ||
}} | }} | ||
| − | Upsell Plus is a feature in [[NATS4]] that allows you to offer your [[Ct#Member|members]] incentives to sign up for other [[Ct#Site|sites]] after they have joined one of your | + | Upsell Plus is a feature in [[NATS4]] that allows you to offer your [[Ct#Member|members]] incentives to sign up for other [[Ct#Site|sites]] after they have joined one of your sites. In order to complete the [[Ct#Upsell|Upsell]] Plus process, the member will have to click on a link that you provide for them. |
| − | == Creating | + | == Creating an Upsell Link == |
| − | If you want to offer the Upsell Plus feature to your | + | If you want to offer the Upsell Plus feature to your members, first create an upsell in the [[Upsells Admin]], then provide your member with a link to your Upsell Plus option. This supports one of two link formats: |
| − | + | <br><br> | |
| − | Preferred | + | Preferred format: |
| − | * <nowiki> | + | * <kbd><nowiki>https://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username></nowiki></kbd> |
| − | **''Siteid and Username is the preferred | + | **''Siteid and Username is the preferred method'' |
| + | Alternative format: | ||
| + | * <kbd><nowiki>https://<linkdomain>/signup/upsellplus.php?memberid=<memberid>&natssess=<nats_session>&site=<siteid></nowiki></kbd> | ||
<br> | <br> | ||
| − | + | For all links, replace <kbd><linkdomain></kbd> with the [[Ct#Linkdomain|linkdomain]] of the site that is offering this upsell and <kbd><siteid></kbd> with the site ID this member has already joined under. Replace <kbd><memberid></kbd>, <kbd><nats_session></kbd>, and <kbd><username></kbd> in the above examples with the member ID, session ID, and username of the member, respectively. Although both of the example formats will work with Upsell Plus, the first format is preferred. | |
| − | + | <br><br> | |
| − | < | + | You can also specify multiple sites to check through (to use with network member sites, for example): |
| − | + | * <kbd><nowiki>https://<linkdomain>/signup/upsellplus.php?siteids=<siteid>,<siteid2>,<siteid3>&username=<username></nowiki></kbd> | |
| − | |||
| − | < | ||
| − | |||
== Optional Variables == | == Optional Variables == | ||
| − | + | Upsell Plus supports the use of additional variables to get certain effects from your Upsell Plus sales: | |
| − | If you want | + | * If you want members to be automatically submitted for upsells, add <kbd>&upsellid=<upsellid>&email=<email>&submit=1</kbd> to the end of the Upsell Plus URL. Replace <kbd><email></kbd> with the e-mail address of the member and <kbd><upsellid></kbd> with the Outgoing Upsell ID of the upsell to purchase, found in the Upsells Admin. |
| − | + | * If you want any of the available upsell options on the [[Ct#Join Form|join form]] to be pre-checked, add <kbd>&upsellids=<upsellid_list></kbd> to the end of the Upsell Plus URL. Replace <kbd><upsellid_list></kbd> with a comma-separated list of ID numbers for the upsell options you want to be automatically checked. | |
| − | If you want any of the available | + | * Some billers also support passing additional custom variables by adding <kbd>&member_extra[<upsellid>][<customvariable>]=<customvalue></kbd> to the Upsell Plus URL. Billers that currently support this are: |
| − | + | ** [[NATS4_Epoch#UpsellPlus|Epoch]] | |
| − | Some billers also support passing additional custom variables by adding | + | ** [[NATS4_SegPay#Cross Sells and Upsells|Segpay]] |
| − | * [[NATS4_Epoch#UpsellPlus | Epoch]] | + | * To use autocampaigns with internal upsells, add <kbd>&autocamp=campaign</kbd> to the Upsell Plus URL. '''NOTE:''' For this to work, you must set <kbd>$config['ALLOW_REQUEST_AUTOCAMP']=1</kbd> in your ''config.php'' file and add "autocamp" as a hidden variable in the gateway_upsell and thirdparty_upsell templates: <code><input type="hidden" name="autocamp" value="{$smarty.request.autocamp}"></code> |
| − | * [[NATS4_SegPay#Cross Sells and Upsells | Segpay]] | ||
| − | |||
== Site Templates == | == Site Templates == | ||
| − | Once you have set up your | + | Once you have set up your upsell options, your Upsell Plus URL, and any optional variables you wish to add to the process, you will need to modify new site [[Ct#Template|templates]] if you want to customize the design of the Upsell Plus pages visited by your members: |
| − | + | * '''gateway_upsell''' - Displayed to the member when they click an upsellplus link if their original subscription was purchased through a gateway biller | |
| − | * gateway_upsell - | + | * '''thirdparty_upsell''' - Displayed to the member when they click an upsellplus link if their original subscription was purchased through a third-party biller |
| − | * page_upsell_approval - | + | * '''page_upsell_approval''' - Displayed to the member if their upsell is approved |
| − | * page_upsell_denial - | + | * '''page_upsell_denial''' - Displayed to the member if their upsell is denied |
| − | + | There is also a '''_mobile''' version for each of the above templates, which is displayed to the member if NATS detects they are using a mobile device. | |
== Additional Security == | == Additional Security == | ||
| − | As of [[NATS]] version 4.1, Upsell Plus offers additional | + | As of [[NATS]] version 4.1, Upsell Plus offers additional features that you can use to secure your member upsells. Member authentication strings allow you to require a verification string with member upsell submissions in order to prevent unwanted upsell attempts from outside sources, and traffic throttling allows you to prevent unwanted repeated access to your Upsell Plus pages. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | === Authentication Strings === | |
| − | + | This feature is disabled by default. If you want to enable this feature for your Upsell Plus transactions, enable the '''MEMBER_STRING_AUTH_UPSELLPLUS''' setting in the "Security" section of the [[NATS4 Configuration Admin|Configuration Admin]]. | |
| − | + | Once you have activated this setting, use the GET /member/authstring REST API endpoint to get the correct auth string for the member you want to process an upsell for. Please see our '''[[NATS4 REST API Get Member Auth String|REST API Get Member Auth String]]''' wiki article for more information on this process. | |
| + | This function will return the necessary auth string for the member to authenticate their Upsell Plus attempts. Include this auth string in the link for your member as shown in the example below: | ||
<pre> | <pre> | ||
| − | + | https://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username>&authstring=<authstring> | |
</pre> | </pre> | ||
=== Throttling === | === Throttling === | ||
| − | Throttling is a security setting available in | + | Throttling is a security setting available in NATS 4.1 that allows you to temporarily lock out incoming traffic from a specific IP address if they submit too many requests to certain pages in NATS. |
| − | You can use the Throttling feature to help secure your ''upsellplus.php'' page, preventing | + | You can use the Throttling feature to help secure your ''upsellplus.php'' page, preventing surfers from forcing transactions without the correct auth string. Throttling settings are available in the "Security" section of the Configuration Admin. |
| − | + | Please visit our '''[[Throttling]]''' wiki article for general information about this feature. | |
[[Category:NATS4 Upsells]] | [[Category:NATS4 Upsells]] | ||
Revision as of 22:00, 14 June 2019
Upsell Plus is a feature in NATS4 that allows you to offer your members incentives to sign up for other sites after they have joined one of your sites. In order to complete the Upsell Plus process, the member will have to click on a link that you provide for them.
Creating an Upsell Link
If you want to offer the Upsell Plus feature to your members, first create an upsell in the Upsells Admin, then provide your member with a link to your Upsell Plus option. This supports one of two link formats:
Preferred format:
- https://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username>
- Siteid and Username is the preferred method
Alternative format:
- https://<linkdomain>/signup/upsellplus.php?memberid=<memberid>&natssess=<nats_session>&site=<siteid>
For all links, replace <linkdomain> with the linkdomain of the site that is offering this upsell and <siteid> with the site ID this member has already joined under. Replace <memberid>, <nats_session>, and <username> in the above examples with the member ID, session ID, and username of the member, respectively. Although both of the example formats will work with Upsell Plus, the first format is preferred.
You can also specify multiple sites to check through (to use with network member sites, for example):
- https://<linkdomain>/signup/upsellplus.php?siteids=<siteid>,<siteid2>,<siteid3>&username=<username>
Optional Variables
Upsell Plus supports the use of additional variables to get certain effects from your Upsell Plus sales:
- If you want members to be automatically submitted for upsells, add &upsellid=<upsellid>&email=<email>&submit=1 to the end of the Upsell Plus URL. Replace <email> with the e-mail address of the member and <upsellid> with the Outgoing Upsell ID of the upsell to purchase, found in the Upsells Admin.
- If you want any of the available upsell options on the join form to be pre-checked, add &upsellids=<upsellid_list> to the end of the Upsell Plus URL. Replace <upsellid_list> with a comma-separated list of ID numbers for the upsell options you want to be automatically checked.
- Some billers also support passing additional custom variables by adding &member_extra[<upsellid>][<customvariable>]=<customvalue> to the Upsell Plus URL. Billers that currently support this are:
- To use autocampaigns with internal upsells, add &autocamp=campaign to the Upsell Plus URL. NOTE: For this to work, you must set $config['ALLOW_REQUEST_AUTOCAMP']=1 in your config.php file and add "autocamp" as a hidden variable in the gateway_upsell and thirdparty_upsell templates:
<input type="hidden" name="autocamp" value="{$smarty.request.autocamp}">
Site Templates
Once you have set up your upsell options, your Upsell Plus URL, and any optional variables you wish to add to the process, you will need to modify new site templates if you want to customize the design of the Upsell Plus pages visited by your members:
- gateway_upsell - Displayed to the member when they click an upsellplus link if their original subscription was purchased through a gateway biller
- thirdparty_upsell - Displayed to the member when they click an upsellplus link if their original subscription was purchased through a third-party biller
- page_upsell_approval - Displayed to the member if their upsell is approved
- page_upsell_denial - Displayed to the member if their upsell is denied
There is also a _mobile version for each of the above templates, which is displayed to the member if NATS detects they are using a mobile device.
Additional Security
As of NATS version 4.1, Upsell Plus offers additional features that you can use to secure your member upsells. Member authentication strings allow you to require a verification string with member upsell submissions in order to prevent unwanted upsell attempts from outside sources, and traffic throttling allows you to prevent unwanted repeated access to your Upsell Plus pages.
Authentication Strings
This feature is disabled by default. If you want to enable this feature for your Upsell Plus transactions, enable the MEMBER_STRING_AUTH_UPSELLPLUS setting in the "Security" section of the Configuration Admin.
Once you have activated this setting, use the GET /member/authstring REST API endpoint to get the correct auth string for the member you want to process an upsell for. Please see our REST API Get Member Auth String wiki article for more information on this process.
This function will return the necessary auth string for the member to authenticate their Upsell Plus attempts. Include this auth string in the link for your member as shown in the example below:
https://<linkdomain>/signup/upsellplus.php?site=<siteid>&username=<username>&authstring=<authstring>
Throttling
Throttling is a security setting available in NATS 4.1 that allows you to temporarily lock out incoming traffic from a specific IP address if they submit too many requests to certain pages in NATS.
You can use the Throttling feature to help secure your upsellplus.php page, preventing surfers from forcing transactions without the correct auth string. Throttling settings are available in the "Security" section of the Configuration Admin.
Please visit our Throttling wiki article for general information about this feature.
