Ta strona opisuje publiczne API JavaScript służące do odczytu stanu zgody, reagowania na zmiany oraz sterowania dialogiem z poziomu aplikacji.
Załaduj PrivacyKit globalnie, zanim zaczniesz wywoływać metody API.
<head>
<script type="module" src="https://cdn.privacykit.eu/v1/index.esm.js"></script>
...
</head>Cały publiczny dostęp odbywa się przez globalny obiekt window.PrivacyKit, niezależnie od sposobu ładowania skryptu.
const api = window.PrivacyKit;
if (api?.hasConsent('analytics')) {
// udzielono zgody na analitykę
}
const unsubscribe = api?.onConsentChanged(consent => {
console.log('Consent changed', consent);
});
PrivacyKit udostępnia pełne API pod window.PrivacyKit.
window.PrivacyKit = {
onReady,
readConsent,
hasConsent,
onConsentChanged,
openConsentDialog,
onConsentDialogClosed,
openPrivacyPolicyDialog,
toggleComplianceMonitor,
getSubscriptionStatus,
subscriptionStatus,
};Subskrybuje zdarzenie cyklu życia privacykit:ready, gdy API staje się dostępne.
onReady(callback: () => void): () => voidwindow.PrivacyKit?.onReady(() => {
// Tutaj bezpiecznie wywołujesz metody API PrivacyKit
const consent = window.PrivacyKit.readConsent();
// ...
});Odczytuje bieżący cookie zgody i zwraca znormalizowany obiekt.
readConsent(): {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null
Ocena zgody dla pojedynczej kategorii lub wyrażenia.
hasConsent(expression?: string): booleanSubskrybuje zmiany zgody i zwraca funkcję wypisania.
onConsentChanged(callback: (consent: {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null) => void): () => void
Programowo otwiera dialog PrivacyKit.
openConsentDialog(): voidSubskrybuje zdarzenia zamknięcia dialogu.
onConsentDialogClosed(callback: () => void): () => voidProgramowo otwiera okno dialogowe Polityki prywatności w trybie standalone i ponownie wykorzystuje stylowanie oraz zawartość slotów z zadeklarowanego consent-dialog.
openPrivacyPolicyDialog(): voidWłącza lub wyłącza PrivacyKit Compliance Monitor. Po włączeniu w rogu strony pojawia się pływający przycisk akcji, który zapewnia dostęp do okna dialogowego Monitor.
toggleComplianceMonitor(): voidZwraca aktualny status subskrypcji dla domeny. To jest pomocnicza funkcja tylko do odczytu — subskrypcja i rozliczenia są zarządzane automatycznie przez PrivacyKit za pośrednictwem Paddle.
getSubscriptionStatus(): {
status: string | null;
billingInterval: string | null;
subscriptionEnd: string | null;
trailingEnd: string | null;
} | null