Consent Management API für JavaScript-Integrationen.

Consent-Status per JavaScript sicher abfragen.

Fügen Sie Ihren Integrationscode direkt nach dem ConsentBoost-Loader ein. Über window.ConsentboostConsent können Sie den aktuellen Status abfragen, ohne auf das Laden weiterer Seitenelemente warten zu müssen.

<script
    id="Consentboost"
    src="https://cdn.consentboost.com/loader.js">
</script>
<script>
    const snapshot = window.ConsentboostConsent.getSnapshot();

    if (
        snapshot.ready === true
        && snapshot.categories.media === 'granted'
    ) {
        startMediaFeature();
    }
</script>

Braucht die Consent API einen API-Key?

Nein. Die dokumentierte Schnittstelle ist keine externe REST-API, sondern eine read-only Browser-API. Der ConsentBoost-Loader stellt window.ConsentboostConsent direkt auf der eingebundenen Website bereit; ein separater API-Key, eine Anmeldung aus dem Browser oder ein HTTP-Endpunkt sind dafür nicht vorgesehen.

• Binden Sie zuerst den ConsentBoost-Loader für die angelegte Domain ein.
• Lesen Sie den Status anschließend über getSnapshot() oder subscribe(callback).
• Behandeln Sie eine fehlende API oder ready === false immer als nicht freigegeben.
• Übermitteln Sie keine geheimen Zugangsdaten in clientseitigem JavaScript.

Welche Daten liefert die Consent Management API?

getSnapshot() liefert den Consent-Status zum Zeitpunkt des Aufrufs. Das Ergebnis hat immer dieselbe Struktur und enthält keine Kennung des Besuchers.

{
    api_version: '1',
    ready: false,
    decision: 'loading',
    categories: {
        necessary: 'granted',
        functional: 'denied',
        statistics: 'denied',
        marketing: 'denied',
        media: 'denied'
    }
}

api_version

Version der API-Antwort. Diese Dokumentation beschreibt Version 1.

ready

Zeigt, ob der Status bereits sicher ausgewertet werden kann. Bei false dürfen optionale Dienste nicht gestartet werden.

decision

Fasst den aktuellen Stand der Besucherentscheidung zusammen, zum Beispiel pending, partial oder rejected.

categories

Enthält für necessary, functional, statistics, marketing und media jeweils granted oder denied.

Werten Sie für einen Dienst nur die Kategorie aus, der er in ConsentBoost zugeordnet ist. Eine Freigabe für Statistik gilt beispielsweise nicht automatisch für Marketing oder externe Medien.

Eine optionale Kategorie, die auf der Website nicht verwendet wird, bleibt denied. Deshalb kann decision den Wert partial haben, obwohl der Besucher allen auf der Website angezeigten Kategorien zugestimmt hat. Für die Steuerung eines Dienstes ist daher immer dessen konkreter Kategorienwert maßgeblich.

Bedeutung von decision.

Auf spätere Entscheidungen reagieren.

Mit subscribe(callback) erhalten Sie sofort den aktuellen Status und anschließend jede relevante Änderung. So kann Ihre Integration einen Dienst nach einer Zustimmung aktivieren oder nach einer Ablehnung beziehungsweise einem Widerruf wieder deaktivieren.

const unsubscribe = window.ConsentboostConsent.subscribe(
    (snapshot) => {
        const allowed = snapshot.ready === true
            && snapshot.categories.media === 'granted';

        mediaAdapter.setEnabled(allowed);
    }
);

// Beim Entfernen der eigenen Komponente:
unsubscribe();

• Der erste Aufruf liefert immer den Status, der bei der Registrierung gilt.
• Ihr Callback wird nur erneut ausgeführt, wenn sich die ausgegebenen Werte ändern.
• Ein Fehler in Ihrem Callback beeinträchtigt weder ConsentBoost noch andere Integrationen.
• Rufen Sie die zurückgegebene Funktion auf, wenn Ihre Komponente keine weiteren Updates benötigt.

Consent-Status fail-closed validieren.

Behandeln Sie einen optionalen Zweck nur dann als freigegeben, wenn die API bereit ist und der konkrete Kategorienwert exakt granted lautet. Fehlende API, Ladezustand, unbekannter Wert oder Fehlerpfad dürfen keinen optionalen Dienst aktivieren.

const api = window.ConsentboostConsent;
const snapshot = api?.getSnapshot?.();

const marketingAllowed = snapshot?.ready === true
    && snapshot.categories?.marketing === 'granted';

if (marketingAllowed) {
    startMarketingFeature();
}

• Prüfen Sie ready und die konkrete Kategorie gemeinsam.
• Leiten Sie keine Freigabe allein aus decision ab.
• Planen Sie einen sicheren Zustand ein, falls die API noch nicht verfügbar ist.
• Testen Sie Erstbesuch, Ablehnung, Auswahl, Zustimmung und Widerruf getrennt.

Consent-Status mit jedem Ereignis senden.

Sendet Ihre Website Ereignisse an einen eigenen Server oder an einen angebundenen Dienst, ergänzen Sie jeden Request um die aktuell freigegebenen Zwecke. Der Server erhält damit den Consent-Status, der beim Erzeugen des Ereignisses galt, und kann ihn direkt bei der Verarbeitung berücksichtigen. Die Consent-API läuft im Browser und stellt keinen separaten serverseitigen Abfrage-Endpunkt bereit.

let sequence = 0;
let current = window.ConsentboostConsent.getSnapshot();

window.ConsentboostConsent.subscribe((snapshot) => {
    current = snapshot;
});

function sendPartnerEvent(eventPayload) {
    sequence += 1;
    const ready = current.ready === true;

    return fetch('https://partner.example/events', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({
            sequence,
            event: eventPayload,
            purposes: {
                functional: ready && current.categories.functional === 'granted',
                statistics: ready && current.categories.statistics === 'granted',
                marketing: ready && current.categories.marketing === 'granted',
                media: ready && current.categories.media === 'granted'
            }
        })
    });
}