Skip to main content

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

PropertyTypeRequired?Description
urlstringYesThe website's URL in string format
customizationCustomization ObjectNoThe customization used for the banner.

Customization Object

PropertyTypeRequired?Description
colorsColors ObjectNoThe colors used in the banner.
settingsSettings ObjectNoThe general settings for the banner.
advanceSettingsAdvance Settings ObjectNoThe advance settings for the banner.
messagesHash mapYesA hashmap with language code as a key and the text messages to be used in the banner.

Colors Object

PropertyTypeRequired?Description
backgroundstringNoThe background color in HEX format.
buttonBackgroundstringNoThe button background color in HEX format.
fontstringNoThe font color in HEX format.

Settings Object

PropertyTypeRequired?Description
positioningstringNoThe banner’s position. Can be 'top', 'bottom', 'squaredLeft', 'squaredRight', 'squaredCentered'
showDSRUrlbooleanNoWhether the banner shows a link to the DSR form (if any).
showPoweredBybooleanNoWhether the banner shows the “Powered by illow” legend.
showCircledWidgetbooleanNoWhether the rounded logo is shown after user gave the consent.
bannerLogostringNoThe rounded logo to be shown after user gave the consent. Can be 'illow', 'cookie', 'gdpr', 'lgpd', 'ccpa'
activeMultilanguagebooleanNoWhether the banner is shown in the language configured in the user’s browser. If false, fixedLang is used.
fixedLangstringNoThe ISO code for the language to be used in case activeMultilanguage is false.
showBlurBackgroundbooleanNoIf the background is blurred (true) or not (false), prioritizing the user's consent before interacting with the content of the page.

Advance Settings Object

PropertyTypeRequired?Description
fullyCompliantBannerGlobal Banner Configs ObjectNoThe advance settings for the banner.
gdprBannerGDPR Banner Configs ObjectNoThe advance settings for the banner.
ccpaBannerUS-opout Banner Configs ObjectNoThe advance settings for the banner.
generalGeneral Banner Configs ObjectNoThe advance settings for all banner.

Global Banner Configs Object

PropertyTypeRequired?Description
iabTcfModebooleanNoWhether the iab banner will be enabled for GDPR banners (true) or displayed as standard illow settings (false).
permissivebooleanNoWhether if the banner won't block cookies as soon as it starts (true) or if it will (false).

GDPR Banner Configs Object

PropertyTypeRequired?Description
iabTcfModebooleanNoWhether the iab banner will be enabled for GDPR banners (true) or displayed as standard illow settings (false).
permissivebooleanNoWhether if the banner won't block cookies as soon as it starts (true) or if it will (false).
resourceBlockerbooleanNoWhether resources should be locked (true) or not (false).

US-opout Banner Configs Object

PropertyTypeRequired?Description
noticeUSAbooleanNoWhether the notice USA mode is being activated or not.

General Banner Configs Object

PropertyTypeRequired?Description
showPoweredBybooleanNoWhether 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"
}
}
}
  1. Creating a domain with default branding an squared left positioning
{
"url": "my-domain.com",
"customization": {
"settings": {
"positioning": "squaredLeft"
}
}
}
  1. Creating a domain with custom message in english
{
"url": "my-domain.com",
"customization": {
"messages": {
"en": {
"mainMessage": "This website uses cookies"
}
}
}
}
  1. Creating a domain with platform's default
{
"url": "my-domain.com"
}
  1. 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

PropertyTypeDescription
idstringThe domain's ID within illow
codestringThe 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!