Quickstart - Integrating Termly CMP

This quickstart guide is designed for Termly Integration Partners (e.g. website builders) who are aiming to integrate Termly into their platform as a Consent Management Platform (CMP) solution for their own users.

Below we outline (1) a step-by-step process for a basic integration and (2) advice for more advanced customization scenarios.

Basic Integration

These steps outline the minimal interaction a platform would have with Termly’s API in order to get a working CMP installed on a website that they manage.

1. Create Website Configuration

Create a new website in your partner account, providing necessary details like the website’s URL and business information.

Documentation: Websites API

2. Initiate Website Scan

Start a website scan to identify cookies, trackers, and other elements requiring consent.

Documentation: Scan API

3. Monitor Scan Progress

Track the scan status through the API until completion to proceed with further setup.

Documentation: Scan report API

4. Implement CMP Embed Script

Embed the CMP script in the website’s <head> section post-scan, enabling the consent banner for site visitors.

Documentation: Websites API

Advanced Configuration Options

Advice and best practices for further implementation of the Termly CMP.

Banner appearance and behavior can be modified to suit each website’s needs. Some Integration Partners see value in setting a standardized configuration across all sites that they manage, while others expose certain controls to their users to allow for some control.

Documentation: Banner Settings, Theming

User Collaboration

Integration Partners may want their users to get access to the Termly Dashboard for full customization of their CMP solution, or in order to generate legal policies.

The collaborators API can be used to invite a user to access a specific site via an invite URL, which they can use to log in to the Termly Dashboard.

Documentation: Collaborators API

Script Blocking Management

In order for the CMP to be effective at respecting a site visitor’s consent preferences, a script blocking method must be employed.

To streamline this process, Integration Partners may want to generate a custom blocking map across the sites that they manage. This allows for consistent blocking behavior across many websites, which can be useful in the case where the same service is employed across them all (e.g. a third party booking service).

Additionally, Integrators who provide their customers an interface to add third party scripts on their site may want to expand this UI to allow for categorization of these scripts for the purpose of script blocking.