Difference between revisions of "Cookies"

From WHMCS Documentation
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
Cookies are small text files stored by your device when you access most websites on the internet. And WHMCS is no exception.  There are two types of cookie:
+
WHMCS uses cookies to maintain session state and store small amounts of data on visitors’ computers or devices.
  
−
*'''Session cookies''' - these expire when you close your browser and do not remain on your computer.
+
<div class="docs-alert-info">Cookies are small text files that most websites on the internet store on your device and use to improve your overall experience.</div>
−
*'''Persistent cookies''' - these are stored long term on your computer for a period specified in the code.
 
  
−
Below is an explanation of all the cookies created by the WHMCS client area, which type they are, and what purpose each serves.
+
WHMCS uses two types of cookie:
  
−
*PHPSESSID - Probably the most common cookie that most PHP based websites will use. This is used to store the unique session ID for each visitor and enables variables to be remembered and passed between page loads.  This is a session only cookie so expires as soon as the browser is closed.
+
*'''Session cookies''' — These expire when you close your browser. They do not remain on your computer.
 +
*'''Persistent cookies''' — These stay on your computer for a defined period of time.
  
−
*WHMCSAffiliateID - This cookie gets set when a customer is referred to you via an affiliate.  It simply stores the ID of the affiliate that referred them, so that if an order is placed within the next 90 days following the referral, the affiliate gets credited for it.  It is a persistent cookie.
+
WHMCS creates the following cookies when you use the WHMCS client area:
  
−
*WHMCSLinkID - This cookie gets set only if you use the link tracking feature of WHMCS (Utilities > Link Tracking). It remembers the link the visitor followed to first get to your website, and is then used when an order is placed to be able to associate the conversion with a link to be able to provide stats on the effectiveness of your links.  It is a persistent cookie.
+
*'''WHMCSInstanceID''' — This is the most common cookie that most PHP-based websites will use. This stores the unique session ID for each visitor and enables variables to pass between page loads.  The cookie only contains a reference to a session on the web server. The user's browser won't store any personal information.  This is a session-only cookie, so it expires as soon as you close the browser.
  
−
*WHMCSUID/WHMCSPW - These 2 cookies are used for the remember me functionality of the client area.  They only get set should a client choose to have their details remembered so they don't have to re-login every time they visit your website.  They are persistant and last for 365 days, or until logout.
+
*'''WHMCSAffiliateID''' — WHMCS sets this cookie when an affiliate refers a customer to you.  It stores the ID of the affiliate that made the referral so that if the customer places an order within the next 90 days following the referral, the affiliate receives credit for it. It is a persistent cookie.
  
−
==Notifying Users==
+
*'''WHMCSLinkID''' — WHMCS only sets this cookie if you use the link tracking ('''Utilities > [[Link Tracking]]''').  It remembers the link the visitor followed to get to your website, and the system uses it when receiving an order, to be able to associate the conversion with a link to be able to provide stats such as the conversion rate of your links.  It is a persistent cookie.
−
It is our understanding that as the PHPSESSID and WHMCSUID/WHMCSPW cookies are used for keeping track of user input and progressing through the shopping cart, there is no obligation to obtain consent from your visitors as this is one of the exceptions under the EU e-Privacy Directive.
 
  
−
However if you intend to use the affiliate or link tracking features then you should inform clients about the WHMCSAffiliateID and WHMCSLinkID cookies which are used for tracking purposes.
+
*'''WHMCSUser''' — WHMCS uses this cookie for the remember me functionality of the client area. The system only sets it if a client chose to have the system remember their details, ensuring that they don't need to log in multiple times. It is persistent and lasts for 365 days, or until logout.

Latest revision as of 14:47, 14 March 2022

WHMCS uses cookies to maintain session state and store small amounts of data on visitors’ computers or devices.

Cookies are small text files that most websites on the internet store on your device and use to improve your overall experience.

WHMCS uses two types of cookie:

  • Session cookies — These expire when you close your browser. They do not remain on your computer.
  • Persistent cookies — These stay on your computer for a defined period of time.

WHMCS creates the following cookies when you use the WHMCS client area:

  • WHMCSInstanceID — This is the most common cookie that most PHP-based websites will use. This stores the unique session ID for each visitor and enables variables to pass between page loads. The cookie only contains a reference to a session on the web server. The user's browser won't store any personal information. This is a session-only cookie, so it expires as soon as you close the browser.
  • WHMCSAffiliateID — WHMCS sets this cookie when an affiliate refers a customer to you. It stores the ID of the affiliate that made the referral so that if the customer places an order within the next 90 days following the referral, the affiliate receives credit for it. It is a persistent cookie.
  • WHMCSLinkID — WHMCS only sets this cookie if you use the link tracking (Utilities > Link Tracking). It remembers the link the visitor followed to get to your website, and the system uses it when receiving an order, to be able to associate the conversion with a link to be able to provide stats such as the conversion rate of your links. It is a persistent cookie.
  • WHMCSUser — WHMCS uses this cookie for the remember me functionality of the client area. The system only sets it if a client chose to have the system remember their details, ensuring that they don't need to log in multiple times. It is persistent and lasts for 365 days, or until logout.
Retrieved from "http://3.17.75.209/index.php?title=Cookies&oldid=31678"