You can configure the SDK behavior by passing preliminary options before loading the script.
When loading the script, our SDK will check if an axeptioSettings object has been previously declared. If so, it will retrieve these parameters.
When you install Axeptio:
By copying and pasting our script, you will see one of the first mandatory settings which is the clientId.
This is the unique identifier of your project that allows you to load your configuration.
You also have the cookiesVersion which is one of the parameters that can be sent to our SDK.
All axeptioSettings options
In the axeptioSettings object, you can add other parameters that our SDK knows how to interpret.
Like here the userCookiesDuration which is the number of days for the cookie's lifetime.
Here configured to 180 days.
All parameters have default values that you can leave unchanged.
window.axeptioSettings = {
userCookiesDuration: 180
}
The different properties of this object are as follows:
/** @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';
/**
* Boolean for the geolocation feature
* To base it on the website's language
* Or the browser language (default)
* @type {boolean}
*/
useDocumentLang = false;
Varnish
For Varnish users, content caching prohibits the use of cookies unless they are prefixed. See the Gandi documentation on this subject. To work around this limitation, you can rename the two Axeptio cookies by declaring them in your axeptioSettings object:
window.axeptioSettings = {
authorizedVendorsCookieName: "STYXKEY_axeptio_vendors",
jsonCookieName: "STYXKEY_axeptio_json"
}