JavaScript-API (Legacy-Version)

Überblick

Mit der JavaScript-API von Pandectes kann Ihr Shop mit dem Einwilligungsbanner interagieren, statt sich allein auf dessen eingebautes Verhalten zu verlassen. Entwicklerinnen und Entwickler erhalten damit Werkzeuge, um den aktuellen Zustand von Banner und Einwilligung auszulesen, Aktionen auszulösen und auf Ereignisse zu reagieren, direkt aus dem Theme Ihres Shops oder aus eigenen Skripten. Diese Seite beschreibt die Möglichkeiten der API in der Version für den Legacy-Banner.

Was können Sie mit der Legacy-JavaScript-API tun?

Zustand von Banner und Einwilligung auslesen

Die API stellt schreibgeschützte Eigenschaften bereit, die den aktuellen Zustand des Banners und der Einwilligung jederzeit widerspiegeln. Sie können prüfen:

• ob API und Banner vollständig geladen und einsatzbereit sind
• ob der Banner gerade auf dem Bildschirm sichtbar ist
• ob der Banner für den aktuellen Besucher überhaupt gilt (auf Basis der Geolokalisierungsregeln)
• ob die Geolokalisierung aktiv ist und in welchem Land der Besucher erkannt wurde
• in welcher Sprache der Banner derzeit angezeigt wird
• den Einwilligungsstatus des Besuchers für jede einzelne Cookie-Kategorie: unbedingt erforderlich, Funktionalität, Leistung, Targeting und nicht klassifizierte Cookies
• ob der Besucher im Banner auf Allow, Decline oder Dismiss geklickt hat

So erhält Ihr Shop eine Momentaufnahme in Echtzeit darüber, wozu ein Besucher zugestimmt und wie er mit dem Banner interagiert hat.

Die Anzeige des Banners steuern

Über die API können Sie den Banner programmgesteuert ein- oder ausblenden, statt sich allein auf die automatischen Anzeigeregeln zu verlassen. Konkret können Sie:

• den Banner anzeigen — den Einwilligungsbanner für den Besucher erzwingen
• den Banner ausblenden — ihn aus der Ansicht entfernen, wahlweise samt Ein- oder Ausblenden der Schaltfläche zum Widerruf beziehungsweise erneuten Öffnen
• die Widerrufsschaltfläche ein- oder ausblenden — die kleine Schaltfläche, über die Besucher den Banner nach einer bereits getroffenen Entscheidung erneut öffnen können

Das ist nützlich, wenn Sie den Banner als Reaktion auf eine bestimmte Nutzeraktion auslösen möchten, etwa den Klick auf einen Link "Cookie-Einstellungen" in Ihrem Footer.

Das Präferenzfenster öffnen und schließen

Über den Hauptbanner hinaus gibt Ihnen die API auch Kontrolle über das Cookie-Präferenzfenster, in dem Besucher einzelne Cookie-Kategorien annehmen oder ablehnen. Sie können:

• das Präferenzfenster direkt öffnen
• es programmgesteuert schließen
• die aktuellen Präferenzen des Besuchers speichern und das Fenster in einem Schritt schließen
• den Status einzelner Kategorie-Kontrollkästchen im Fenster setzen
• Einwilligungsänderungen auf Kategorieebene mit unterschiedlicher Granularität anwenden

Damit lassen sich vollständig eigene Einwilligungsabläufe umsetzen, bei denen das Präferenzfenster außerhalb des Banners ausgelöst oder verwaltet wird.

Einen Widerruf der Einwilligung auslösen

Die API ermöglicht es, eine zuvor erteilte Einwilligung programmgesteuert zu widerrufen. Das setzt den Einwilligungsstatus zurück und öffnet standardmäßig den Banner erneut, damit der Besucher eine neue Entscheidung treffen kann. Optional lässt sich das automatische erneute Öffnen unterbinden, wenn Sie diesen Schritt selbst übernehmen möchten.

Eine "Seite verlassen"-Aktion auslösen

Die API enthält eine Methode, um die Leave-Site-Funktion auszulösen, also dieselbe Aktion wie beim Klick auf eine entsprechende Schaltfläche im Banner. Das ist hilfreich, wenn Sie Besuchern im Rahmen eines eigenen Datenschutzablaufs eine ausdrückliche Möglichkeit bieten möchten, den Shop zu verlassen.

Auf Banner- und Einwilligungsereignisse reagieren

Die API löst zu wichtigen Zeitpunkten im Lebenszyklus des Banners Ereignisse aus, sodass Ihr Shop in Echtzeit reagieren kann. Sie können auf Folgendes hören:

• wenn die Pandectes-API initialisiert und bereit ist
• wenn die Seite vollständig geladen ist
• wenn der Standort des Besuchers erkannt wurde (nützlich für Logik auf Basis der Geolokalisierung)
• wenn die Sprache des Banners festgelegt wurde
• wenn der Banner sichtbar wird
• wenn der Banner ausgeblendet wird
• wenn der Besucher auf die Leave-Site-Schaltfläche klickt
• wenn der Banner geschlossen wird (nach einer Einwilligungsentscheidung)
• wenn eine Einwilligungsentscheidung getroffen oder aktualisiert wird
• wenn der Besucher das Präferenzfenster öffnet

Über diese Ereignisse können andere Skripte und Integrationen in Ihrem Shop unmittelbar auf Einwilligungsänderungen reagieren, etwa indem ein Tracking-Skript genau dann geladen wird, wenn ein Besucher die Einwilligung erteilt, ganz ohne Neuladen der Seite.

Für wen ist das gedacht?

Die JavaScript-API richtet sich an Händler mit einer Entwicklerin oder einem Entwickler sowie an Shops mit einem eigenen oder headless Storefront. Der Banner funktioniert vollständig ohne jede Nutzung der API. Sie ist für fortgeschrittene Szenarien gedacht, in denen eine engere Verzahnung mit dem Verhalten Ihres Shops nötig ist.

Erste Schritte

Die vollständige API-Referenz finden Sie in der Pandectes-App unter Settings → JavaScript API. Wenn Sie Unterstützung bei einem konkreten Anwendungsfall brauchen, wenden Sie sich an unser Supportteam.

Aktualisiert am: 22/09/2026