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.phpDaten 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 |
|
von |
Anfangsdatum |
1983-07-15 |
|
zu |
Enddatum |
2018-08-02 |
|
tippe |
Datentyp: · 1 = CMP-Bericht · 2 = Pubvendors-Bericht (nicht länger unterstützt) · 3 = Crawler-Bericht · 4 = Einwilligungsprotokoll · 5 = CMP-Liste · 6 = Entwurfsliste · 7 = (Cookie) Domain-Liste · 8 = Textversionen · 9 = Benutzerdefinierte Lieferantenliste · 10 = Liste für benutzerdefinierte Zwecke · 11 = Betriebssystemliste · 12 = Browserliste · 13 = Geräteliste · 14 = Liste der Zustimmtypen · 15 = Letzte Crawling-IDs · 16 = (CMP-Zustellung) Domänenliste · 17 = Unterkonten · 18 = Änderungsprotokoll · 19 = Zustimmungsprotokoll |
1 |
|
Ausgabe |
CSV oder JSON |
JSON |
|
alle |
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"
}, ...
]
}Zustimmungsprotokoll (Typ = 4)
Nicht länger unterstützt. Verwenden Sie stattdessen type=19.
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)
Hinweis: Wenn der Parameter & all = 1 festgelegt ist, meldet die API alle erstellten benutzerdefinierten und Systemanbieter. Wenn der Parameter nicht auf 0 (Null) gesetzt oder gesetzt ist, meldet die API nur Anbieter, die derzeit für einen Ihrer CMPs verwendet werden.
{
"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"
},...
]
}Liste der Zustimmtypen (Typ = 14)
{
"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)
Bitte verwenden Sie den Parameter &domainid=X, um eine bestimmte Domain-ID abzufragen. Andernfalls gibt die Liste die IDs aus, die in diesem Datumsbereich (zB heute) verwendet wurden.
{
"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":{...}
}, ...
]
}Zustimmungsprotokoll (Typ = 19)
Dieser Typ kann verwendet werden, um das Zustimmungsprotokoll (Protokoll) für ein Konto abzurufen. Hinweis: Protokolle werden nach 7 Tagen an das Archiv gesendet und können nicht mehr über die API heruntergeladen werden.
