PrivacyKit API-viite

Tällä sivulla dokumentoidaan julkinen JavaScript API, jolla luetaan suostumustila, reagoidaan suostumuksen muutoksiin ja ohjataan dialogin kulkua sovelluskoodista.

Sisällysluettelo

Skriptin asennus

NPM

Lataa PrivacyKit kerran globaalisti ennen kuin kutsut mitään API-metodeja.

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

Käyttö

Kaikki julkinen käyttö kulkee globaalin window.PrivacyKit -olion kautta riippumatta siitä, miten skripti ladataan.

const api = window.PrivacyKit;

if (api?.hasConsent('analytics')) {
  // analytiikkasuostumus annettu
}

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

Window-nimiavaruus

PrivacyKit julkaisee koko API:n window.PrivacyKit -oliossa.

window.PrivacyKit = {
  onReady,
  readConsent,
  hasConsent,
  onConsentChanged,
  openConsentDialog,
  onConsentDialogClosed,
  openPrivacyPolicyDialog,
  toggleComplianceMonitor,
  getSubscriptionStatus,
  subscriptionStatus,
};
subscriptionStatus on valinnainen ja voi olla null, jos se ei ole saatavilla.

Julkiset metodit

onReady

Tilaa privacykit:ready-elinkaaritapahtuman, kun API on käytettävissä.

onReady(callback: () => void): () => void
Palauttaa peruutusfunktion.

window.PrivacyKit?.onReady(() => {
  // PrivacyKitin API-metodeja on turvallista kutsua täällä
  const consent = window.PrivacyKit.readConsent();
  // ...
});
onReady on toistoturvallinen — jos se on jo lauennut, uudet kuuntelijat kutsutaan heti.

readConsent

Lukee nykyisen suostumusevästeen ja palauttaa normalisoidun suostumusolion.

readConsent(): {
  analytics: boolean;
  marketing: boolean;
  preferences: boolean;
} | null
Palauttaa null, jos kelvollista suostumusevästettä ei ole.

hasConsent

Arvioi suostumuksen yksittäiselle kategorialle tai lausekkeelle.

hasConsent(expression?: string): boolean

Jos lauseke puuttuu: vaatii kaikki kategoriat.
Yksi kategoria: analytics, marketing tai preferences.
JA-lauseke: analytics+marketing.
TAI-lauseke: analytics|marketing.

onConsentChanged

Tilaa suostumuspäivitykset ja palauttaa peruutusfunktion.

onConsentChanged(callback: (consent: {
  analytics: boolean;
  marketing: boolean;
  preferences: boolean;
} | null) => void): () => void
Palauttaa peruutusfunktion.

openConsentDialog

Avaa PrivacyKit-dialogin ohjelmallisesti.

openConsentDialog(): void

onConsentDialogClosed

Tilaa dialogin sulkeutumistapahtumat.

onConsentDialogClosed(callback: () => void): () => void
Palauttaa peruutusfunktion.

openPrivacyPolicyDialog

Avaa Tietosuojakäytäntö-dialogin ohjelmallisesti erillisessä tilassa käyttäen ilmoitetun consent-dialogin tyylejä ja slot-sisältöä uudelleen.

openPrivacyPolicyDialog(): void
Hyödyllinen, kun linkität tietosuojakäytäntöön omasta käyttöliittymästäsi.

toggleComplianceMonitor

Ottaa PrivacyKit Compliance Monitorin käyttöön tai poistaa sen käytöstä. Kun se on käytössä, sivun kulmaan ilmestyy kelluva toimintopainike, josta pääsee Monitor-valintaikkunaan.

toggleComplianceMonitor(): void

getSubscriptionStatus

Palauttaa verkkotunnuksen nykyisen tilaustilan. Tämä on vain luku -apu — tilaus ja laskutus hoidetaan automaattisesti PrivacyKitin toimesta Paddlen kautta.

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