Vous pouvez configurer le comportement du SDK en passant des options préalables au chargement du script.
Lors du chargement du script, notre SDK va venir vérifier si un objet axeptioSettings a été préalablement déclaré. Si tel est le cas, il ira piocher dans ces paramètres.
Lorsque vous installez Axeptio :
En copiant / collant notre script, vous pourrez voir un des premiers settings obligatoire qui est le clientId.
C'est l'identifiant uniquement de votre projet qui permet de charger votre configuration.
Vous avez aussi la cookiesVersion qui est un des paramètre qui peut être envoyé à notre SDK.
Toutes les options d'axeptioSettings
Dans l'objet axeptioSettings, vous pouvez ajouter d'autres paramètres que notre SDK sait interpreter.
Comme ici le userCookiesDuration qui est le nombre de jours de durée de vie du cookie.
Ici configuré a 180 jours.
L'ensemble des paramètres ont des valeurs par défaut que vous pouvez laisser sans y toucher.
window.axeptioSettings = {
userCookiesDuration: 180
}
Les différentes propriétés de cet objet sont les suivantes :
/** @type {string} clientId ObjectID corresponding to the project object */
clientId;
/** @type {Token} user token set by the website (if the user is logged in)*/
tokenInstance;
/**
* String identifier of the version of Cookie configuration
* that should be loaded. If this parameter is omitted, then it's the "pages"
* property in the configuration that gets parsed in case of
* multiple cookies configurations.
* @type {string}
*/
cookiesVersion;
/**
* Flag to tell whether GTM Events should be written in the dataLayer variable or not
* @type {boolean}
*/
triggerGTMEvents = true;
/**
* Name of the cookies containing the JSON value of user choices
* @type {string}
*/
jsonCookieName = 'axeptio_cookies';
/**
* Name of the cookies that stores authorized vendors (comma-separated string)
* @type {string}
*/
authorizedVendorsCookieName = 'axeptio_authorized_vendors';
/**
* Name of the cookies that stores authorized vendors (comma-separated string)
* @type {string}
*/
allVendorsCookieName = 'axeptio_all_vendors';
/**
* Number of days used the cookie holding user's choices should be active
* @type {number|"page"|"session"}
*/
userCookiesDuration = 365;
/**
* If specified, domain name on which the cookie containing user choices
* will be available. This allows to request one consent for various subdomains
* @type {string}
*/
userCookiesDomain = 'mondomaine.com';
/**
* If specified, define the SameSite value of the cookie. Usually Lax, Strict or None.
* @type {string}
*/
userCookiesSameSite;
/**
* Whether or not the cookie holding choices is HTTPS only
* @type {boolean}
*/
userCookiesSecure = true;
/**
* If set to true, Axeptio will open the cookie widget if the vendors described
* in the current cookie config do not match the vendors saved in the visitors
* cookies.
* @type {boolean}
*/
openCookiesWidgetIfVendorsMismatch = false;
/**
* ClassName of the <div> tag were Axeptio's WebsiteOverlay will be mounted
* @type {string}
*/
mountClassName = 'axeptio_mount';
/**
* URL on which the widget will send its POST and GET requests, if you use serverSide
* for querying and storing consent proofs.
* @type {string}
*/
apiUrl = 'https://api.axept.io/v1';
Varnish
window.axeptioSettings = {
authorizedVendorsCookieName: "STYXKEY_axeptio_vendors",
jsonCookieName: "STYXKEY_axeptio_json"
}