Info
Content

Data-API

De Data-API maakt het downloaden van ruwe data van het systeem mogelijk. De Data-API is te vinden op het eindpunt

https://www.consentmanager.net/api/data.php

Gegevens ophalen

Om de gegevens van uw CMP's op te halen, stuurt u een HTTP GET naar de Data-API met de volgende parameters:

Parameter

Omschrijving

Voorbeeld

sleutel

Verificatiesleutel

jf892rt

van

Begin datum

1983-07-15

naar

Einddatum

2018-08-02

type dan:

Data type:

·         1 = CMP-rapport

·         2 = Pubvendors rapport (Niet langer gesteund)

· 3 = Crawlerrapport

·         4 = Toestemmingslogboek

· 5 = CMP-lijst

· 6 = Designlijst

· 7 = (Cookie) Domeinlijst

· 8 = Tekstversies

· 9 = Aangepaste leverancierslijst

· 10 = Aangepaste doellijst

· 11 = OS-lijst

· 12 = Browserlijst

· 13 = Apparatenlijst

· 14 = Toestemmingstypelijst

· 15 = Laatste crawl-ID's

· 16 = (CMP-levering) Domeinlijst

· 17 = Subaccounts

· 18 = Wijzigingslogboek

· 19 = Toestemmingslogboek

1

uitgang

csv of json

json

allen

0 of 1. Alleen geldig voor type = 9

1

Resultaat

De API retourneert het volgende object:

{ 
  "status":"created", //status, always “created” 
  "message": "Data report created", //status message 
  "data": "…" //data payload as csv or json format
}

Belangrijk: Houd er rekening mee dat het uitvoerformaat van de gegevenspayload van tijd tot tijd kan veranderen (bijv. Nieuwe kolommen worden toegevoegd, kolommen verwijderd, kolommen gewijzigd). Neem bij het ontwerpen van uw software de nodige stappen om veranderingen in de datastructuur te detecteren.

Voorbeelden

CMP-rapport (type = 1)

{
  "status":"created",
  "message":"Data report created",
  "data": [ 
    {
      "cmpID":"3",
      "designID":"13",
      "country":"DE",
      "date":"2019-05-27",
      "hour":"23",
      "urlID":"123",
      "osID":"2",
      "uaID":"4",
      "deviceID":"2",
      "pageView":"3",
      "consentView":"0",
      "consentAccept":"0",
      "consentReject":"0",
      ...
    }, ...
   ]
}  

Rapport pub pubers (type = 2)

Niet langer gesteund.

Crawlerrapport (type = 3)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {"cmpID":"4",
     "date":"2019-05-22",
     "hour":"21",
     "crawls":"8",
     "cookiesFound":"564",
     "cookiesNew":"10",
     "domainsFound":"431",
     "domainsNew":"1"
    }, ...
  ]
}

Niet langer gesteund. Gebruik in plaats daarvan type=19.

CMP-lijst (type = 5)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"3",
      "name":"My CMP",
      "status":"1"
    }, ...
  ]
}

Ontwerplijst (type = 6)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"1",
      "name":"[Default]\/Bottom right",
      "status":"1",
      "defaultDesign":"1"
    }, ...
  ]
}    

(Cookie) Domeinlijst (type = 7)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"1",
      "domain":"example.com"
    }, ...
  ]
}    

Tekstversies (type = 8)

Opmerking: de API geeft de standaardteksten voor alle talen als id = 0.

{
  "status":"created",
  "message":"Data report created",
  "data":[
   {
     "id":0,
     "design":0,
     "date":null,
     "lang":"EN",
     "jsonText":
     {
       "cc":"en",
       "load":"Loading",
       "hl":"We value your privacy!",
       "txt":"...",...
     }
   }, ...
  ]
}

Aangepaste leverancierslijst (type = 9)

Opmerking: als parameter & all = 1 is ingesteld, rapporteert de API alle aangepaste en systeemleveranciers die zijn gemaakt. Als de parameter niet is ingesteld of is ingesteld op 0 (nul), rapporteert de API alleen leveranciers die momenteel in gebruik zijn voor uw CMP.

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"c24",
      "cmp":"3",
      "name":"Google Ads",
      "link":"https:\/\/policies.google.com\/privacy?hl=en&gl=ZZ",
      "logo":"\/delivery\/icons_c24.ico"
    }, ...
  ]
}

Lijst met aangepaste doeleinden (type = 10)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"1",
      "cmp":"3",
      "name":"My Purpose",
      "description":"..."
    }, ...
  ]
}

OS-lijst (type = 11)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":0,
      "name":"unknown"
    },
    {
      "id":2,
      "name":"Windows"
    }, ...
  ]
}

Browserlijst (type = 12)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":0,
      "name":"unknown"
    },
    {
      "id":16,
      "name":"Google Chrome"
    }, ...
  ]
}

Apparatenlijst (type = 13)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":0,
      "name":"unknown"
    },
    {
      "id":2,
      "name":"Desktop"
    },...
  ]
}
{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":0,
      "name":"unknown"
    },
    {
      "id":1,
      "name":"Button click: Accept all"
    }, ... 
  ]
}

Laatste crawl-ID's (type = 15)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"23380",
      "url":"https:\/\/www....",
      "startDate":"2019-05-25 21:04:22",
      "risk":"100"
    }, ...
  ]
}

(CMP-levering) Domeinlijst (type = 16)

Gebruik de parameter &domainid=X om een ​​specifieke domein-ID op te vragen. Anders geeft de lijst de ID's weer die in deze periode zijn gebruikt (bijvoorbeeld vandaag).

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"1",
      "domain":"example.com"
    }, ...
  ]
}    

Subaccounts (type = 17)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"3",
      "login":"...",
      "mail":"...",
      "rights":"cmp;designs;texts;...",
      "restrictCMP":"0",
      "allowedCMP":"3;4",
      "status":"1",
      "lastLogin":"2019-07-27 17:32:53"
    }, ...
  ]
}

Changelog (type = 18)

{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "id":"820",
      "datatype":"designs",
      "changetype":"1",
      "itemID":"11",
      "userID":"1",
      "subaccountID":"-1",
      "accountID":"0",
      "changedate":"2019-07-27 18:36:40",
      "oldData":{...},
      "newData":{...}
    }, ...
  ]
}

Dit type kan worden gebruikt om het toestemmingslogboek (protocol) voor een account op te halen. Let op: Protocollen worden na 7 dagen naar het archief gestuurd en kunnen niet meer worden gedownload via de API.

Terug naar boven