Fetch Consent Banner settings

Once the company site is created, you can fetch all its details by sending a GET request to our API to the endpoint:

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

info

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

Response Body

Format: JSON

Property	Type	Description
customization	Customization Object	The customization used for the banner.
url	string	The website's URL in string format
id	string	The website's URL in string format
code	string	The script tag to place in the site HTML (preferably within the `<head>`).
pageViews	number	The number of visits you received (counts visits, not visitors).
integrated	boolean	If the banner was integrated (true) or not (false), into the site.

Customization Object

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

Colors Object

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

Settings Object

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

Advance Settings Object

Property	Type	Description
showPoweredBy	boolean	Whether the banner shows the “Powered by illow” legend.
noticeUSA	boolean	Whether the notice USA mode is being activated or not.
permissive	boolean	Whether if the banner won't block cookies as soon as it starts (true) or if it will (false).
resourceBlocker	boolean	Whether resources should be locked (true) or not (false).
iabTcfMode	boolean	Whether the iab banner will be enabled for GDPR banners (true) or displayed as standard illow settings (false).

Example

{
  "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"
    },
    "advanceSettings": {
      "showPoweredBy": true,
      "noticeUSA": false,
      "permissive": false,
      "resourceBlocker": false,
      "iabTcfMode": false,
   },
    "messages": {
      "en": {
        "mainMessage": "This site uses cookies"
      },
      "es": {
        "mainMessage": "Este sitio usa cookies"
      }
    },
    "id": "8374978f-51d8-421c-8f6e-da3734db7226",
    "code": "<script src='https://platform.illow.io/banner.js?siteId=8374978f-51d8-421c-8f6e-da3734db7226'></script>",
    "pageViews": 52002,
    "integrated": true
  }
}

Interactive API Reference

Take a look at our interactive Swagger Site!

Fetch Consent Banner settings

Response Body​

Customization Object​

Colors Object​

Settings Object​

Advance Settings Object​

Example​

Interactive API Reference​