Info
Innehåll

Data-API

Data-API tillåter nedladdning av rådata från systemet. Data-API kan hittas vid slutpunkten

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

Hämta data

För att hämta data från dina CMP: er, skicka en HTTP GET till Data-API med följande parametrar:

Parameter

Beskrivning

Exempelvis

nyckel

Autentiseringsnyckel

jf892rt

från

Startdatum

1983-07-15

till

Slutdatum

2018-08-02

Typ

Data typ:

· 1 = CMP-rapport

·         2 = Pubvendorsrapport (stöds inte längre)

· 3 = Crawler-rapport

· 4 = Samtyckslogg

· 5 = CMP-lista

· 6 = Designlista

· 7 = (Cookie) Domain List

· 8 = Textversioner

· 9 = Anpassad leverantörslista

· 10 = Custom purpose List

· 11 = OS-lista

· 12 = Webbläsarlista

· 13 = Enhetslista

· 14 = Lista över samtycktyper

· 15 = Senaste genomsöknings-ID

· 16 = (CMP-leverans) Domänlista

· 17 = Underkonton

· 18 = ändringslogg

1

produktion

csv eller json

json

alla

0 eller 1. Gäller endast för typ = 9

1

Resultat

API kommer att returnera följande objekt:

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

Viktigt: Observera att utgångsformatet för datolastbelastningen kan ändras från tid till annan (t.ex. nya kolumner läggs till, kolumner tas bort, kolumner ändras). När du utformar din programvara, ta de nödvändiga stegen för att upptäcka förändringar i datastrukturen.

Exempel

CMP-rapport (typ = 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",
      ...
    }, ...
   ]
}  

Pubvendorsrapport (typ = 2)

Stöds inte längre.

Crawler-rapport (typ = 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"
    }, ...
  ]
}
{
  "status":"created",
  "message":"Data report created",
  "data":[
    {
      "cmpID":"3",
      "date":"2019-01-20 13:17:26",
      "pubCookie":"1",
      "country":"DE",
      "ip":"127.0.0.0",
      "browser":"Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:64.0) Gecko\/20100101 Firefox\/64.0",
      "url":"http:\/\/...",
      "consentString":"BOaXPxSOarARhAfA70DECC-AAAAjyAJAAMACkALYAggBcgDHAIGASoA4wA==",
      "lang":"DE",
      "designID":"52",
      "consentType":"8",
      "customVendors":"_8_3_9_7_10012_10013",
      "customPurposes":null,
      "textVersion":"10",
      "internalID":"",
      "externalID":"",
      "externalID2":"",
      "externalID3":"",
      "osID":"0",
      "uaID":"0",
      "deviceID":"0",
      "urlID":"0",
      "cmpversion":"0",
      "designversion":"0"
    },  ...
  ]
}

CMP-lista (typ = 5)

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

Designlista (typ = 6)

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

(Cookie) Domänlista (typ = 7)

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

Textversioner (typ = 8)

Obs: API: n ger standardtexterna för alla språk som 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":"...",...
     }
   }, ...
  ]
}

Anpassad leverantörslista (typ = 9)

Obs! Om parameter & all = 1 är inställd rapporterar API: n alla anpassade leverantörer och systemleverantörer som har skapats. Om parametern inte är inställd eller satt till 0 (noll) rapporterar API: et endast leverantörer som för närvarande används för någon av dina 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"
    }, ...
  ]
}

Lista med anpassat ändamål (typ = 10)

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

OS-lista (typ = 11)

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

Webbläsarlista (typ = 12)

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

Enhetslista (typ = 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"
    }, ... 
  ]
}

Senaste genomsöknings-ID (typ = 15)

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

(CMP-leverans) Domänlista (typ = 16)

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

Underkonton (typ = 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 (typ = 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":{...}
    }, ...
  ]
}

 

Tillbaka till toppen