Info
Inhalt

Daten-API

Die Daten-API ermöglicht das Herunterladen von Rohdaten vom System. Die Daten-API befindet sich am Endpunkt

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

Daten abrufen

Um die Daten Ihrer CMPs abzurufen, senden Sie bitte ein HTTP-GET mit den folgenden Parametern an die Daten-API:

Parameter

Beschreibung

Beispiel

Schlüssel

Authentifizierungsschlüssel

jf892rt

ab

Anfangsdatum

1983-07-15

zu

Enddatum

2018-08-02

Typ

Datentyp:

·         1 = CMP report

·         2 = Pubvendors-Bericht (nicht länger unterstützt)

·         3 = Crawler report

·         4 = Consent log

·         5 = CMP List

·         6 = Design List

·         7 = (Cookie) Domain List

·         8 = Textversions

·         9 = Custom vendor List

·         10 = Custom purpose List

·         11 = OS List

·         12 = Browser List

·         13 = Device List

·         14 = Consent Type List

·         15 = Last crawl IDs

·         16 = (CMP delivery) Domain List

·         17= Subaccounts

·         18=changelog

1

Ausgabe

CSV oder JSON

JSON

aller

0 oder 1. Nur gültig für Typ = 9

1

Ergebnis

Die API gibt das folgende Objekt zurück:

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

Wichtig: Bitte beachten Sie, dass sich das Ausgabeformat der Datennutzdaten von Zeit zu Zeit ändern kann (z. B. neue Spalten hinzugefügt, Spalten entfernt, Spalten geändert). Führen Sie beim Entwerfen Ihrer Software die erforderlichen Schritte aus, um Änderungen in der Datenstruktur zu erkennen.

Beispiele

CMP-Bericht (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",
      ...
    }, ...
   ]
}  

Pubvendors-Bericht (Typ = 2)

Nicht länger unterstützt.

Crawler-Bericht (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-Liste (Typ = 5)

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

Entwurfsliste (Typ = 6)

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

(Cookie) Domain-Liste (Typ = 7)

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

Textversionen (Typ = 8)

Hinweis: Die API gibt die Standardtexte für alle Sprachen als id = 0 an.

{
  "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":"...",...
     }
   }, ...
  ]
}

Benutzerdefinierte Lieferantenliste (Typ = 9)

Note: If parameter &all=1 is set, the API will report all custom and system vendors that are created. If the parameter is not set or set to 0 (zero), the API will only report vendors that are currently in use for any of your 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"
    }, ...
  ]
}

Liste für benutzerdefinierte Zwecke (Typ = 10)

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

Betriebssystemliste (Typ = 11)

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

Browserliste (Typ = 12)

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

Geräteliste (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"
    }, ... 
  ]
}

Letzte Crawl-IDs (Typ = 15)

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

(CMP-Zustellung) Domänenliste (Typ = 16)

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

Unterkonten (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"
    }, ...
  ]
}

Änderungsprotokoll (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":{...}
    }, ...
  ]
}

 

Nach oben