PrivacyKit API-Referenz

Diese Seite dokumentiert die öffentliche JavaScript-API zum Auslesen von Einwilligungen, zum Reagieren auf Änderungen und zur Steuerung des Dialogflusses aus Anwendungscode.

Inhaltsverzeichnis

Skripteinbindung

Laden Sie PrivacyKit einmal global, bevor Sie API-Methoden aufrufen.

<head>
  <script type="module" src="https://cdn.privacykit.eu/v1/index.esm.js"></script>
  ...
</head>

Verwendung

Der gesamte öffentliche Zugriff erfolgt über das globale Objekt window.PrivacyKit, unabhängig davon, wie das Skript geladen wird.

const api = window.PrivacyKit;

if (api?.hasConsent('analytics')) {
  // Analytics-Einwilligung erteilt
}

const unsubscribe = api?.onConsentChanged(consent => {
  console.log('Consent changed', consent);
});

Window-Namespace

PrivacyKit stellt die komplette API unter window.PrivacyKit bereit.

window.PrivacyKit = {
  onReady,
  readConsent,
  hasConsent,
  onConsentChanged,
  openConsentDialog,
  onConsentDialogClosed,
  openPrivacyPolicyDialog,
  toggleComplianceMonitor,
  getSubscriptionStatus,
  subscriptionStatus,
};
subscriptionStatus ist optional und kann null sein, wenn keine Daten vorliegen.

Öffentliche Methoden

onReady

Abonniert das Lebenszyklusereignis privacykit:ready, sobald die API verfügbar ist.

onReady(callback: () => void): () => void
Gibt eine Abmeldefunktion zurück.

window.PrivacyKit?.onReady(() => {
  // Hier können Sie PrivacyKit-API-Methoden gefahrlos aufrufen
  const consent = window.PrivacyKit.readConsent();
  // ...
});
onReady ist replay-sicher — wenn es bereits ausgelöst wurde, werden neu abonnierte Listener sofort aufgerufen.

readConsent

Liest die aktuelle Einwilligungs-Cookie und gibt ein normalisiertes Objekt zurück.

readConsent(): {
  analytics: boolean;
  marketing: boolean;
  preferences: boolean;
} | null
Gibt null zurück, wenn kein gültiges Einwilligungs-Cookie vorhanden ist.

hasConsent

Bewertet die Einwilligung für eine einzelne Kategorie oder einen Ausdruck.

hasConsent(expression?: string): boolean

Ohne Ausdruck: alle Kategorien sind erforderlich.
Einzelne Kategorie: analytics, marketing oder preferences.
UND-Ausdruck: analytics+marketing.
ODER-Ausdruck: analytics|marketing.

onConsentChanged

Abonniert Einwilligungsänderungen und gibt eine Abmeldefunktion zurück.

onConsentChanged(callback: (consent: {
  analytics: boolean;
  marketing: boolean;
  preferences: boolean;
} | null) => void): () => void
Gibt eine Abmeldefunktion zurück.

openConsentDialog

Öffnet den PrivacyKit-Dialog programmatisch.

openConsentDialog(): void

onConsentDialogClosed

Abonniert Dialog-Schließereignisse.

onConsentDialogClosed(callback: () => void): () => void
Gibt eine Abmeldefunktion zurück.

openPrivacyPolicyDialog

Öffnet den Datenschutzdialog programmatisch im Standalone-Modus und verwendet dabei das Styling sowie die Slot-Inhalte des deklarierten consent-dialogs erneut.

openPrivacyPolicyDialog(): void
Nützlich, wenn Sie aus Ihrer eigenen UI auf die Datenschutzerklärung verlinken möchten.

toggleComplianceMonitor

Aktiviert oder deaktiviert den PrivacyKit Compliance Monitor. Wenn aktiviert, erscheint in der Ecke der Seite ein schwebender Aktionsbutton und bietet Zugriff auf den Monitor-Dialog.

toggleComplianceMonitor(): void

getSubscriptionStatus

Gibt den aktuellen Abonnementstatus für die Domain zurück. Dies ist ein schreibgeschützter Helfer — Abonnement und Abrechnung werden automatisch von PrivacyKit über Paddle verwaltet.

getSubscriptionStatus(): {
  status: string | null;
  billingInterval: string | null;
  subscriptionEnd: string | null;
  trailingEnd: string | null;
} | null