Information
Contenu

API de données

Data-API permet de télécharger des données brutes à partir du système. L'API de données se trouve au point de terminaison

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

Récupérer des données

Afin de récupérer les données de vos CMP, veuillez envoyer un HTTP GET à Data-API avec les paramètres suivants:

Paramètre

Description

Exemple

clé

Clé d'authentification

jf892rt

à partir de

Date de début

1983-07-15

à

Date de fin

2018-08-02

type

Type de données:

· 1 = rapport CMP

·         2 = rapport Pubvendors (N'est plus pris en charge)

· 3 = rapport du robot d'exploration

· 4 = journal de consentement

· 5 = Liste CMP

· 6 = Liste de conception

· 7 = Liste des domaines (cookie)

· 8 = Textversions

· 9 = Liste de fournisseurs personnalisée

· 10 = Liste des objectifs personnalisés

· 11 = Liste des systèmes d'exploitation

· 12 = Liste du navigateur

· 13 = Liste des périphériques

· 14 = Liste des types de consentement

· 15 = ID du dernier crawl

· 16 = (livraison CMP) Liste de domaines

· 17 = Sous-comptes

· 18 = journal des modifications

1

sortie

csv ou json

json

tous

0 ou 1. Uniquement valable pour le type = 9

1

Le résultat

L'API renverra l'objet suivant:

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

Important: veuillez noter que le format de sortie de la charge utile de données peut changer de temps en temps (par exemple, de nouvelles colonnes étant ajoutées, des colonnes supprimées, des colonnes modifiées). Lors de la conception de votre logiciel, veuillez prendre les mesures nécessaires afin de détecter les changements dans la structure des données.

Exemples

Rapport CMP (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 Pubvendors (type = 2)

N'est plus pris en charge.

Rapport du robot d'exploration (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"
    }, ...
  ]
}
{
  "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"
    },  ...
  ]
}

Liste CMP (type = 5)

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

Liste de conception (type = 6)

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

(Cookie) Liste de domaines (type = 7)

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

Textversions (type = 8)

Remarque: L'API donnera les textes par défaut pour toutes les langues comme 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":"...",...
     }
   }, ...
  ]
}

Liste de fournisseurs personnalisée (type = 9)

Remarque: Si le paramètre & all = 1 est défini, l'API signalera tous les fournisseurs personnalisés et système créés. Si le paramètre n'est pas défini ou défini sur 0 (zéro), l'API signalera uniquement les fournisseurs qui sont actuellement utilisés pour l'un de vos 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 des objectifs personnalisés (type = 10)

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

Liste des systèmes d'exploitation (type = 11)

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

Liste du navigateur (type = 12)

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

Liste des appareils (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"
    }, ... 
  ]
}

ID de la dernière analyse (type = 15)

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

(Livraison CMP) Liste de domaines (type = 16)

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

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

Journal des modifications (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":{...}
    }, ...
  ]
}

 

Retour en haut de la page