Información
Contenido

API de datos

La API de datos permite descargar datos sin procesar del sistema. La API de datos se puede encontrar en el punto final

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

Obtener datos

Para obtener los datos de sus CMP, envíe un HTTP GET a la API de datos con los siguientes parámetros:

Parámetro

Descripción

Ejemplo

clave

Clave de autenticación

jf892rt

Fecha de inicio

1983-07-15

a

Fecha de finalización

2018-08-02

tipo

Tipo de datos:

· 1 = informe CMP

·         2 = Informe de publicadores (ya no es compatible)

· 3 = Informe del rastreador

· 4 = Registro de consentimiento

· 5 = Lista CMP

· 6 = Lista de diseños

· 7 = Lista de dominios (cookies)

· 8 = Versiones de texto

· 9 = Lista de proveedores personalizada

· 10 = Lista de propósitos personalizados

· 11 = Lista de SO

· 12 = Lista del navegador

· 13 = Lista de dispositivos

· 14 = Lista de tipos de consentimiento

· 15 = ID de último rastreo

· 16 = (entrega CMP) Lista de dominios

· 17 = Subcuentas

· 18 = registro de cambios

1

salida

csv o json

json

todos

0 o 1. Solo válido para tipo = 9

1

Resultado

La API devolverá el siguiente objeto:

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

Importante: Tenga en cuenta que el formato de salida de la carga útil de datos puede cambiar de vez en cuando (por ejemplo, se agregan nuevas columnas, se eliminan columnas, se cambian columnas). Al diseñar su software, siga los pasos necesarios para detectar cambios en la estructura de datos.

Ejemplos

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

Informe de publicadores (tipo = 2)

Ya no es compatible.

Informe de rastreador (tipo = 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"
    },  ...
  ]
}

Lista de CMP (tipo = 5)

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

Lista de diseño (tipo = 6)

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

(Cookie) Lista de dominios (tipo = 7)

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

Versiones de texto (tipo = 8)

Nota: La API proporcionará los textos predeterminados para todos los idiomas como 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":"...",...
     }
   }, ...
  ]
}

Lista de proveedores personalizados (tipo = 9)

Nota: Si se establece el parámetro & all = 1, la API informará todos los proveedores personalizados y de sistemas que se creen. Si el parámetro no se establece o se establece en 0 (cero), la API solo informará a los proveedores que están actualmente en uso para cualquiera de sus 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 de propósitos personalizados (tipo = 10)

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

Lista de SO (tipo = 11)

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

Lista del navegador (tipo = 12)

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

Lista de dispositivos (tipo = 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"
    }, ... 
  ]
}

Últimos ID de rastreo (tipo = 15)

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

(Entrega CMP) Lista de dominios (tipo = 16)

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

Subcuentas (tipo = 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"
    }, ...
  ]
}

Registro de cambios (tipo = 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":{...}
    }, ...
  ]
}

 

Volver arriba