All Collections
Setting up tracking and analytics
Integrating third-party consent management with iPaper
Integrating third-party consent management with iPaper

Integrate your website’s consent management solution into your Flipbooks using the Consent Management API

Updated over a week ago

🔰 Before we get started

⚠️ Custom Scripting options are only available to account administrators. If you do not have administrator privileges for your iPaper account, please contact your iPaper account administrator.

This article assumes that you are already familiar with the concept of, and using, a consent management tool. If you’re unsure, this link offers a good introduction into what cookies are, and why consent management is important.

📖 This article explains:

Select the right Consent Management option for your Flipbook

iPaper supports three different consent management options, which can be applied to any Flipbook, or folder:

  • None: We do not handle consent and do not present any form of Consent Management banner.

  • Integration: No cookie banner is presented by iPaper, and you will have to integrate your existing consent management platform with iPaper. We assume only “strictly necessary” consent by default.

  • Basic Banner: iPaper presents a basic cookie consent banner that allows the user to manage consent.

⚠️ This guide explains how to integrate an existing, third-party consent management platform into your Flipbooks. If you'd rather use iPaper's native Basic Cookie consent banner, see our guide, below:

The advantages of integration

1. Once consent is given, it applies across your entire domain

If your business has a website, the chances are high that you already have a consent-management tool that allows visitors to manage, and give consent to cookies being used to gather data on them. iPaper also offers a basic cookie consent banner that you can toggle on or off, for your Flipbooks.

However, using the consent management API, it is also possible to integrate the same consent management solution you use on your website, into your Flipbooks!

The advantage of doing so is that once a visitor to your website has consented to cookies, the user no longer has to give additional consent when browsing your iPaper Flipbook during the same session. This also works the other way around, if the visitor’s first exposure is your Flipbook, they do not need to give consent, when later browsing other parts of your website.

2. Better brand conformity

It’s likely that if you’re using a third-party consent management tool, you’ve branded it so that the banner that is displayed when a new browsing session is started matches the rest of your business’ visual identity.

By integrating the same consent management solution as you use across your website, you ensure continuity of your brand identity regardless of whether a visitor starts their session in your Flipbook, or your website.

3. Greater control of cookie consent across territories, or brands

Different markets, or countries, have different requirements for cookie consent. For businesses with presences across multiple markets, compliance to these rules is essential.

iPaper’s generic solution offers visitors the ability to accept, or decline all cookies, it does not offer the option to turn off/on specific cookie permissions. By using your third-party permissions' solution, you can tailor the consent experience to the requirements of the territory.

Integrating third-party consent management with iPaper

The procedure for integrating your third-party consent management with iPaper flipbooks depends on how you present your Flipbook. More precisely, how you implement your third-party consent management tool differs whether you present your Flipbook on its own subdomain (in that it exists on its own URL), or if it is iframed, or embedded on another webpage.

⚠️ PLEASE NOTE: We recommend that you test your third-party consent management implementation on a single Flipbook first, before further implementation on folder, or account level. This is to ensure that the implementation works correctly.

You'll first want to get yourself acquainted with the technical instructions for implementing your third-party consent management script in iPaper. These are available on our documentation site, below.

💡 We have specific guides available for UserCentrics, OneTrust, CookieBot, and Cookieinformation implementations.

Stand-alone flipbooks

Enable Custom Scripting

In order to integrate a third-party solution with iPaper, you’ll need to have custom scripting on your account. To get this enabled, just reach out to our Customer Care team, and we’ll get this activated for you.

  1. Once custom scripting is enabled on your account, you’ll be able to see the Custom Scripting pane, under the Modules tab either on the folder, or account level.

  2. Navigate to the Custom Scripting pane from the left-hand menu.

  3. Paste the integration code supplied by your third-party consent management solution into the Header scripts(s) box.

⚠️ In addition to your third-party solutions' integration code, you must also include code that passes user consent levels from your third-party script, to iPaper.

Set the correct Consent Management option

With Custom Scripting enabled, and your integration code implemented as per the method above, you'll also need to make sure that you've selected the appropriate Consent Management option in iPaper.

  1. Navigate to the Settings pane for your Flipbook and click the General tab.

  2. In the left-hand menu, select Consent Management.

  3. You'll be presented with 3 options: None, Integration, or Basic Banner. You'll want to select the Integration option. That's it!

Embedded / iframed flipbooks

It’s also possible to integrate a third-party consent management solution when your iPaper Flipbook is embedded within another page on your website.

The integration code and information you will need to embed is the same as for the solution above. The difference is that the code should not be implemented via iPaper. Instead, you’ll need to implement this code directly on the page where your iPaper Flipbook is embedded.

If you already use a tag manager on the page, or site on which your Flipbook is embedded, you can use it to inject the code of your consent management tool directly.

How do I know if I've correctly integrated my third-party consent management solution?

If you've followed the instructions above, you should have correctly implemented your third-party consent management solution.

An easy way to double-check whether everything is tracking as it should be, is by checking the Page views statistic for your Flipbook. To do this, navigate to your Flipbook's Statistics pane, then select the Key Statistics pane.

If the Page views statistics shows no data, even though you accept all cookie categories on your Flipbook, this is indicative that your integration was not correctly integrated. Specifically, the cookie category 'allowPerformanceCookies' variable is then not passed to iPaper as true.

We recommend that you review the integration code you have used, specifically the section where the cookie category acceptance level from your third-party permissions' solution is linked to the acceptance of iPaper's performance cookie.

Applying your integration across folders or on a whole account using inherited settings

Using inherited settings, you can implement a third-party consent solution to apply across your entire iPaper account, or to any Flipbooks within a specific folder. To understand more about inherited settings and how they affect your Flipbooks, check out our guide, below.

If you have questions about integrating your third-party consent management, our Customer Care team is here to help! Just reach out to us using messenger bubble in the corner. 😃

Did this answer your question?