PrivacyKit API-referens

Den här sidan beskriver det offentliga JavaScript-API:t för att läsa samtycke, reagera på ändringar och styra dialogen från din applikation.

Innehåll


Scriptuppsättning

Ladda PrivacyKit globalt innan du anropar API-metoder.

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

Användning

All åtkomst sker via det globala objektet window.PrivacyKit, oavsett hur skriptet laddas.

const api = window.PrivacyKit;

if (api?.hasConsent('analytics')) {
  // analytiskt samtycke givet
}

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

Window-namespace

PrivacyKit exponerar hela API:t på window.PrivacyKit.

window.PrivacyKit = {
  onReady,
  readConsent,
  hasConsent,
  onConsentChanged,
  openConsentDialog,
  onConsentDialogClosed,
  openPrivacyPolicyDialog,
  toggleComplianceMonitor,
  getSubscriptionStatus,
  subscriptionStatus,
};

Publika metoder

onReady

Prenumererar på privacykit:ready när API:t blir tillgängligt.

onReady(callback: () => void): () => void
window.PrivacyKit?.onReady(() => {
  // Här kan du säkert anropa PrivacyKit-API:t
  const consent = window.PrivacyKit.readConsent();
  // ...
});

openConsentDialog

Öppnar PrivacyKit-dialogen programmatiskt.

openConsentDialog(): void

onConsentDialogClosed

Prenumererar på dialogens stängningshändelser.

onConsentDialogClosed(callback: () => void): () => void

openPrivacyPolicyDialog

Öppnar dialogen för integritetspolicy programmatiskt i fristående läge och återanvänder styling och slot-innehåll från den deklarerade consent-dialogen.

openPrivacyPolicyDialog(): void

toggleComplianceMonitor

Aktiverar eller inaktiverar PrivacyKit Compliance Monitor. När den är aktiverad visas en flytande åtgärdsknapp i ett hörn av sidan som ger åtkomst till Monitor-dialogen.

toggleComplianceMonitor(): void

getSubscriptionStatus

Returnerar aktuell abonnemangsstatus för domänen. Detta är en skrivskyddad hjälpfunktion — abonnemang och fakturering hanteras automatiskt av PrivacyKit via Paddle.

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