Creating a Consent Banner

Registering a domain at illow to be scanned, have its cookies and third-party tools categorized and get its own script tag is as easy as sending a POST request to our API to the endpoint:

https://api.platform.illow.io/open-api/v1/company-sites

info

Don't forget to include your Access Key in the X-API-Key header of all your requests.

Request Body

Format: JSON

Property	Type	Required?	Description
url	string	Yes	The website's URL in string format
customization	Customization Object	No	The customization used for the banner.

Customization Object

Property	Type	Required?	Description
colors	Colors Object	No	The colors used in the banner.
settings	Settings Object	No	The general settings for the banner.
advanceSettings	Advance Settings Object	No	The advance settings for the banner.
messages	Hash map	Yes	A hashmap with language code as a key and the text messages to be used in the banner.

Colors Object

Property	Type	Required?	Description
background	string	No	The background color in HEX format.
buttonBackground	string	No	The button background color in HEX format.
font	string	No	The font color in HEX format.

Settings Object

Property	Type	Required?	Description
positioning	string	No	The banner’s position. Can be 'top', 'bottom', 'squaredLeft', 'squaredRight', 'squaredCentered'
showDSRUrl	boolean	No	Whether the banner shows a link to the DSR form (if any).
showPoweredBy	boolean	No	Whether the banner shows the “Powered by illow” legend.
showCircledWidget	boolean	No	Whether the rounded logo is shown after user gave the consent.
bannerLogo	string	No	The rounded logo to be shown after user gave the consent. Can be 'illow', 'cookie', 'gdpr', 'lgpd', 'ccpa'
activeMultilanguage	boolean	No	Whether the banner is shown in the language configured in the user’s browser. If false, fixedLang is used.
fixedLang	string	No	The ISO code for the language to be used in case activeMultilanguage is false.
showBlurBackground	boolean	No	If the background is blurred (true) or not (false), prioritizing the user's consent before interacting with the content of the page.

Advance Settings Object

Property	Type	Required?	Description
fullyCompliantBanner	Global Banner Configs Object	No	The advance settings for the banner.
gdprBanner	GDPR Banner Configs Object	No	The advance settings for the banner.
ccpaBanner	US-opout Banner Configs Object	No	The advance settings for the banner.
general	General Banner Configs Object	No	The advance settings for all banner.

Global Banner Configs Object

Property	Type	Required?	Description
iabTcfMode	boolean	No	Whether the iab banner will be enabled for GDPR banners (true) or displayed as standard illow settings (false).
permissive	boolean	No	Whether if the banner won't block cookies as soon as it starts (true) or if it will (false).

GDPR Banner Configs Object

Property	Type	Required?	Description
iabTcfMode	boolean	No	Whether the iab banner will be enabled for GDPR banners (true) or displayed as standard illow settings (false).
permissive	boolean	No	Whether if the banner won't block cookies as soon as it starts (true) or if it will (false).
resourceBlocker	boolean	No	Whether resources should be locked (true) or not (false).

US-opout Banner Configs Object

Property	Type	Required?	Description
noticeUSA	boolean	No	Whether the notice USA mode is being activated or not.

General Banner Configs Object

Property	Type	Required?	Description
showPoweredBy	boolean	No	Whether the banner shows the “Powered by illow” legend.

Examples

1. Creating a domain with default settings but specific branding

{
  "url": "my-domain.com",
  "customization": {
    "colors": {
      "background": "#89bf04",
      "buttonBackground": "#61affe",
      "font": "#FFFFFF"
    }
  }
}

2. Creating a domain with default branding an squared left positioning

{
  "url": "my-domain.com",
  "customization": {
    "settings": {
      "positioning": "squaredLeft"
    }
  }
}

3. Creating a domain with custom message in english

{
  "url": "my-domain.com",
  "customization": {
    "messages": {
      "en": {
        "mainMessage": "This website uses cookies"
      }
    }
  }
}

4. Creating a domain with platform's default

{
  "url": "my-domain.com"
}

5. Creating a fully-customized domain

{
  "url": "example.com/my-path",
  "customization": {
    "colors": {
      "background": "#E9EEF3",
      "buttonBackground": "#55ADB1",
      "font": "#4A4A4A"
    },
    "settings": {
      "positioning": "top",
      "showDSRUrl": true,
      "enableCCPAMode": true,
      "showCircledWidget": true,
      "bannerLogo": "illow",
      "activeMultilanguage": true,
      "fixedLang": "es",
      "showBlurBackground": false
    },
    "advanceSettings": {
      "general": {
        "showPoweredBy": true,
      },
      "fullyCompliantBanner": {
      "permissive": true,
      "iabTcfMode": false,
      },
      "gdprBanner": {
        "permissive": false,
        "resourceBlocker": false,
        "iabTcfMode": false,
      },
      "ccpaBanner": {
        "noticeUSA": false,
      },

   },
    "messages": {
      "en": {
        "mainMessage": "This site uses cookies"
      },
      "es": {
        "mainMessage": "Este sitio usa cookies"
      }
    }
  }
}

Response Body

Format: JSON

Property	Type	Description
id	string	The domain's ID within illow
code	string	The script tag to be placed in the website's <head> element

Example

{
  "id": "8374978f-51d8-421c-8f6e-da3734db7226",
  "code": "<script src='https://platform.illow.io/banner.js?siteId=8374978f-51d8-421c-8f6e-da3734db7226'></script>"
}

Interactive API Reference

Take a look at our interactive Swagger Site!