PrivacyKit API-referanse

Denne siden dokumenterer JavaScript-API-et for å lese samtykkestatus, reagere på endringer og styre dialogflyten fra applikasjonskode.

Innholdsfortegnelse


Skriptoppsett

Last inn PrivacyKit globalt før du kaller API-metoder.

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

Bruk

All offentlig tilgang går gjennom det globale window.PrivacyKit-objektet, uavhengig av hvordan skriptet lastes.

const api = window.PrivacyKit;

if (api?.hasConsent('analytics')) {
  // analytics-samtykke er gitt
}

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

Window-navnerom

PrivacyKit eksponerer hele API-et på window.PrivacyKit.

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

Offentlige metoder

onReady

Abonnerer på privacykit:ready-livssyklushendelsen når API-et blir tilgjengelig.

onReady(callback: () => void): () => void
window.PrivacyKit?.onReady(() => {
  // Trygt å kalle PrivacyKit API-metoder her
  const consent = window.PrivacyKit.readConsent();
  // ...
});

openConsentDialog

Åpner PrivacyKit-dialogen programmatisk.

openConsentDialog(): void

onConsentDialogClosed

Abonnerer på dialoglukkingshendelser.

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

openPrivacyPolicyDialog

Åpner personvernerklæringsdialogen programmatisk i frittstående modus og gjenbruker styling og slot-innhold fra den deklarerte consent-dialog-en.

openPrivacyPolicyDialog(): void

toggleComplianceMonitor

Aktiverer eller deaktiverer PrivacyKit Compliance Monitor. Når den er aktivert, vises en flytende handlingsknapp i et hjørne av siden og gir tilgang til Monitor-dialogen.

toggleComplianceMonitor(): void

getSubscriptionStatus

Returnerer gjeldende abonnementsstatus for domenet. Dette er en skrivebeskyttet hjelpefunksjon — abonnement og fakturering håndteres automatisk av PrivacyKit via Paddle.

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