This article explains how to install the Axeptio plugin on your website.
To cover as many scenarios as possible that you may encounter, we will go over the following topics:
- Basic installation
- Installation for WordPress
- Installation for PrestaShop
- The most popular CMS software
1. Basic installation
Installing the Axeptio widget on your site is simple and easy. Just run our little script. It is harmless and does not collect any personal data.
Because Axeptio loves diversity, we allow lots of ways to install this popular piece of code:
Directly in your site's code
To integrate Axeptio into your website, you'll need to add our script to your site's code:
- Either in the <head> tag
- Or before the </body> closing tag
✅ We recommend the second method for better performance.
⚠️ Cookie alert: Where do I find the Axeptio script? ⚠️
- Go to your project page in your Axeptio back office.
- Click the gear icon ⚙️ in the top-right corner and then Installation.
- Copy the script below:
<script>
window.axeptioSettings = {
clientId: "xxxxxxxxxxxxxxxxxxxx",
cookiesVersion: "xxxxx"
};
(function(d, s) {
var t = d.getElementsByTagName(s)[0], e = d.createElement(s);
e.async = true; e.src = "//static.axept.io/sdk.js";
t.parentNode.insertBefore(e, t);
})(document, "script");
</script>
Through a Tag Manager interface
For this method, see the article: GTM and Tag Manager Interfaces
✅ Remember to synchronize the user events so that our solution can control your cookies: Integration / Synchronization
2. Installation for WordPress
In WordPress, Axeptio is installed using our in-house plugin.
Let's take a closer look at the following two steps:
Installing the Plugin
✅ The first thing you'll need to do is download our plugin: Download the WordPress plugin here!
✅ Tested WordPress version: V5.5.6
Once this is done, go to your WordPress admin page.
- In the menu's Plugins tab, select Add New:
- Next, click the Upload Plugin button at the top of the page:
- Click the Choose File button that appears. This will open your File Explorer, where you can select the .zip file for the Axeptio plugin that you just downloaded:
- Next, just click the Install now button:
- Finally, on the new page that confirms that the plugin was installed successfully, activate the plugin by clicking the Activate Plugin button:
Configuring the Plugin
The Axeptio plugin is almost ready now. All you need to do is configure it.
- From the Settings tab in the menu of your WordPress admin interface, select axeptio-cookies:
- You'll then see the Axeptio plugin's setup screen, which contains two fields (ID Key and Version):
ID Key: This is your project ID.
To locate it, go to your Axeptio back office and then go to the project you want.
Click the gear icon ⚙️ in the top-right corner.
Copy your project ID and paste it into the ID Key field in WordPress.
Version: This is the ID for the version of your widget that you want to use.
In the backoffice of your Axeptio project, go to the Cookie Management section.
Copy the ID for the version you want (underlined in red below) and paste it into the Version field in WordPress:
- Now, simply click the Save button in WordPress.
Your plugin is now fully operational!
✅ Remember to synchronize the user events so that our solution can control your cookies: Integration / Synchronization
3. Installation for PrestaShop
Want to display our widget in your PrestaShop store? It's super easy to do! Technically, our little piece of code needs to be pasted into the footer on all pages. But we at Axeptio decided to leave your developer alone (because we like to keep him happy), so we developed a module that will automatically publish the code on your site.
And who do you think PrestaShop chose to handle its delicious cookies? Us, of course! And we're super proud to do it 😍
Now, let's take a closer look at the following two steps:
Installing the module
✅ The first thing you'll need to do is download our plugin: Download the PrestaShop plugin here!
✅ PrestaShop plugin compatibility: V1.4.0.1 to V1.7.8.5
- From your PrestaShop admin screen, go to the Improve menu, then Modules and click the Upload a module button:
- Select Axeptio's plugin for PrestaShop that you downloaded through the link above.
Setup and publication
There's just a little more to do to make the Axeptio widget appear on your site. Here are the steps to follow:
- From the modules admin screen in PrestaShop (Improve > Modules) click the Axeptio module that you uploaded:
- Live mode parameter: Enable this setting by setting it to Yes
- Parameter ID: This is the ID for the project for which you wish to activate Axeptio.
To locate it, go to your Axeptio back office and then to the project you want.
Click the gear icon ⚙️ in the top-right corner.
Copy your project ID and paste it into the ID field in PrestaShop.
- Version ID Name parameter: This is the ID for the version of your widget that you want to use.
In the backoffice of your Axeptio project, go to the Cookie Management section.
Copy the ID for the version you want (underlined in red below) and paste it into the Version ID Name field in PrestaShop:
✅ Hello cookston? We have a problem. The widget isn't displaying!
Verify that you've done the following:
- Published the project using Axeptio's back office
- Entered your billing information if you are using premium features
✅ Sometimes, the theme or template you are using does not contain the hook applied for our module.
So, what happens?
The Axeptio widget does not display in your store, and at Axeptio, we want everything to roll along like cookies! We've found a solution for dealing with this, and it's both simple and easy:
- In your PrestaShop panel, select "Add a new module"
- Upload the HTMLbox gratuit module and add it to your store by selecting Choose file and then clicking Upload this module
- Go to Modules > Modules, search for the HTMLbox module, and click Install
- After installing the module, go to Setup
- Paste the Axeptio code
✅ Remember to synchronize the user events so that our solution can control your cookies: Integration / Synchronization
4. The most popular CMS software
Use the procedures below to integrate Axeptio into the following CMS software:
For each of these CMS systems, you'll first need to retrieve our script to be integrated.
⚠️ Cookie alert: Where do I find the Axeptio script? ⚠️
- Go to your project page in your Axeptio back office.
- Click the gear icon ⚙️ in the top-right corner and then Installation.
- Copy the script below:
<script>
window.axeptioSettings = {
clientId: "xxxxxxxxxxxxxxxxxxxx",
cookiesVersion: "xxxxx"
};
(function(d, s) {
var t = d.getElementsByTagName(s)[0], e = d.createElement(s);
e.async = true; e.src = "//static.axept.io/sdk.js";
t.parentNode.insertBefore(e, t);
})(document, "script");
</script>
Shopify
✅ Tested in August 2021
- Log into your Shopify admin page
- In the left menu, go to Online store > Themes
- Click the action menu and select Edit code
- Select the theme.liquid file for your theme
- Paste the snippet of Axeptio code just before the file's closing </body> tag
- Save in the top-right corner, and you're done!
Drupal
✅ Tested in August 2021 // Version 9
- Log into the admin page of your Drupal
- Go to Structure > Block layouts > Custom block library and click Add a custom block
- Select Basic block
- Enter the block description ("Axeptio"), and for Text format, select Full HTML
- In the body, click Source, paste the Axeptio code snippet into the field, and click Save at the bottom of the page
- Return to Block layouts and click the Place block button next to Page footer. Search for the block you just created and click the Position block button next to it
- Uncheck Show title and click Save block
- Click Save blocks, and you're done!
Squarespace
✅ Tested in August 2021 // Official documentation
- Log into your Squarespace account
- In the left menu, go to Settings > Advanced and then Code injection
- Paste the Axeptio code snippet in the Footer section
- In the top-left corner, click Save, and you're done!
Wix
✅ Tested in August 2021 // Official documentation
- Go to the Settings on your site's dashboard.
- Click the Custom Code tab in the Advanced section.
- Click + Add Custom Code in the top-right corner.
- Paste the snippet of Axeptio code into the text box and give it a name ("Axeptio").
- Select the All pages option under Add Code to Pages.
- Select Body - end under Place Code.
- Click Apply, and you're all set!
Webflow
✅ Tested in August 2021 // Official documentation
- Log into your Webflow account and then select your project.
- Click the top-left hamburger menu ☰ and then click Project Settings.
- Click the Custom Code tab.
- Paste the Axeptio code snippet into the Footer Code section and then click Save Changes.
- Publish your site so that the changes take effect, and that's all!
Joomla
✅ Tested in August 2021 // Version 3
- Log into the Joomla admin interface.
- In the menu bar at the top, click Extensions > Templates > Templates.
- Click the name of your template and then index.php in the tree on the left.
- Scroll down to the bottom of the section and paste the snippet of Axeptio code just before the file's closing </body> tag.
- Click Save in the top-left corner, and you're done!
BigCommerce
✅ Tested in August 2021 // Official documentation
- In your BigCommerce admin account, click Storefront and then Script Manager.
- Click Create a Script.
- Fill in the form with the following information:
- Enter Axeptio as the name.
- Select Footer under Location on page.
- Select All pages for the Select pages where script will be added option.
- Select Functional for the Script category option.
- Select Script for the Script Type option.
- Paste the Axeptio code snippet in the Script Content box.
- Click Save in the lower right corner.
HubSpot
✅ Tested in August 2021 // Official documentation
- In your HubSpot account, go to your blog, landing pages, or website pages by clicking Marketing in the top menu.
- Hover your mouse cursor over your content and click Edit.
- In the content editor, click the Settings tab and then Advanced Options.
- In the Additional code snippets section, paste the Axeptio code snippet into the Footer field. (Note: This field is not available in the blog editor. In this scenario, paste the snippet into the header.)
- Click Update in the top-right corner to apply your changes.
Magento
✅ Tested in August 2021 // Official documentation
- Go to your Magento admin panel.
- In the menu on the left, go to Content > Design > Configuration. Here, you can see your site's active theme. On the row for your site, click Edit in the Action column.
- Click the Footer section.
- Paste the Axeptio code snippet in the Miscellaneous HTML field.
- Click the Save configuration button in the top-right corner.
- In the menu on the left, go to System > Tools > Cache Management and click the Flush Magento cache button in the top-right corner.
- You're all set!
Bitrix
✅ Tested in August 2021 (interface)
- In your Bitrix account, go to your site list and click the Actions menu in the top-right corner of your site box, then click Configure site.
- Click More to expand the options and check Custom HTML.
- Paste the Axeptio code snippet into the HEAD box.
- Click the Save button at the bottom of the page.
- You're all set!
TYPO3
✅ Tested in August 2021 // Version 10
- In the TYPO3 admin, click Theme Options in the menu on the left.
- Click Integration.
- Click Enable Body Code and paste the snippet of Axeptio code into the Code before body field.
- Click the Save changes button in the top-right corner, and that's it!
OpenCart
✅ Tested in August 2021 // Version 3
- In the OpenCart admin, click Design > Theme Editor in the menu on the left.
- Under Select theme, click common and then footer.twig.
- In the edit box, scroll down to the closing </body> tag and paste the Axeptio code snippet just above it.
- Click the Save button for the edit box, and you're done!