Domain API / General API

Mit der domainspezifischen API können Sie Consent und Ereignisdaten pro Domain über eine gesicherte SSL Schnittstelle in andere Systeme integrieren.

API Key

Den API Key selbst finden Sie in der unten stehenden Maske. Mit dem Button "Neuen API Key erstellen" wird der Key neu gesetzt und erscheint dann direkt in der Maske.

Beachten Sie bitte, dass bei diesem Schritt evtl. vorhandene Abfragen nicht mehr funktionieren, da der alte Key nicht mehr valide ist.

e3ac4a09a33b48ab437a5f688275bc1955aa0cfe

Der Aufruf erfolgt generell mit Ihrem API Key als GET-Parameter apiKey – ohne diesen ist der Aufruf nicht erfolgreich. Jeder Key ist immer nur für einen Account valide.

Der Aufruf erfolgt generell per simplen GET Aufruf im Browser, curl oder einer beliebigen andere Möglichkeit Webdaten aufzurufen.

API testen

Sie können einen Testaufruf durchführen. Nutzen Sie dafür folgenden API-Endpunkt:

GET /api/test

Darauf sollte das System folgendermaßen antworten.

{
    "username": "Ihr_Username",
    "apiKey": "IHR_API_KEY"
}

Alle Domains des Accounts listen

Um alle Domains Ihres Accounts zu listen, nutzen Sie bitte folgenden API-Endpunkt.

GET /api/domains

Die Antwort sollte folgendermaßen lauten:

[
    {
        "id": "b61cd4a",
        "name": "https:\/\/www.test<nt>-</nt>xy.de",
        "whiteLabel": false,
        "viewCount": 0
    },
    {
        "id": "1ed845d",
        "name": "test<nt>-</nt>12.de",
        "whiteLabel": false,
        "viewCount": 0
    }
]

Die domId ist die wichtigste Information – damit können Sie weitere Informationen zur Domain holen.

Alle Consents aus dem Protokoll holen

Mit dem folgenden API-Endpunkt holen Sie alle Consents aus dem aktuellen Datenblock des Protokolls. Bereits archivierte Protokolleinträge werden dabei nicht berücksichtigt. Bitte ersetzen Sie in der url {domainId} mit einer Domain-ID aus der obigen Abfrage.

GET /api/domains/{domainId}/consents

Die Antwort lautet wie folgt:

[
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208345,
        "purposes": {
            "41ba25c": "Technisch notwendig"
        },
        "embeddings": {
            "16bd7f0": "Papoo CMS Verwaltung der Session"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Technisch notwendig"
        },
        "embeddings": {
            "16bd7f0": "Papoo CMS Verwaltung der Session"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "cba4803da92a9b39ffa82cc93aecbe00bc3f695530ebd3f7e67326404073bdbd",
        "timestamp": 1608131136,
        "purposes": {
            "41ba25c": "Technisch notwendig"
        },
        "embeddings": {
            "16bd7f0": "Papoo CMS Verwaltung der Session"
        },
        "manipulationPrevention": true
    }
]

Aufgelistet werden die Consents folgendermaßen:

- consent: boolean – wurden Consent-Einstellungen vorgenommen - ucid: die individuelle Consent-ID eines Besuchers - timestamp: Zeitstempel des Consents - purposes: Welcher Kategorie der Consent angehört - embeddings: Welchen Einbindungen resp. Cookies der Besucher zugestimmt hat - manipulationPrevention: boolean – ob Versuche zur Manipulation unterbunden wurden. D.h. nicht, dass es welche gab, sondern nur, dass der Unterdrückungs-Mechanismus aktiv war.

Anhand der ucid können Sie Einträge nach Besuchern filtern.

Einen Eintrag finden und Daten auslesen

Mit diesem API-Endpunkt lassen sich die Protokolleinträge nach Consent-ID filtern. Entweder ist diese vollständig anzugeben oder eine Teilzeichenkette beginnend vom Anfang der Consent-ID. Im folgenden Beispiel lassen sich die Einträge also auch mit dem Wert 387f1 für den Parameter {consentId} finden.

Wichtig dabei ist lediglich, dass es nur eine Consent-ID gibt, die mit 387f1 beginnt. Bei Kollisionen liefert die Anfrage eine leere Liste.

GET /api/domains/{domainId}/consents/{consentId}

Dieser Aufruf zeigt dann die gesamte Consent-Historie dieses Key – ein Beispiel

[
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208345,
        "purposes": {
            "41ba25c": "Technisch notwendig"
        },
        "embeddings": {
            "16bd7f0": "Papoo CMS Verwaltung der Session"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Technisch notwendig"
        },
        "embeddings": {
            "16bd7f0": "Papoo CMS Verwaltung der Session"
        },
        "manipulationPrevention": true
    }
]

Sie sehen, die ucid ist jeweils identisch und die Consents haben unterschiedliche Zeitstempel.

Statistik-Daten abrufen

Mit dem folgenden API-Endpunkt können Sie alle Statistik-Daten der letzten 30 Tage von einer Domain auslesen. Bitte ersetzen Sie in der url {domainId} mit einer Domain-ID aus der obigen Abfrage.

GET /api/domains/{domainId}/statistics

Es werden die folgenden Daten pro Tag ausgegeben:

- x → Datum - Calls → Aufrufe des Skripts - Banner views → Banner-Einblendungen - acceptAll → Anzahl der Klicks auf "Alles Akzeptieren" - decline → Anzahl der Klicks auf "Alle ablehnen" - leave → Absprung