Cette page décrit l'API JavaScript publique permettant de lire l'état du consentement, de réagir aux changements et de piloter le dialogue depuis votre application.
Chargez PrivacyKit globalement avant d'appeler les méthodes de l'API.
<head>
<script type="module" src="https://cdn.privacykit.eu/v1/index.esm.js"></script>
...
</head>Tous les accès publics passent par l'objet global window.PrivacyKit, quel que soit le mode de chargement du script.
const api = window.PrivacyKit;
if (api?.hasConsent('analytics')) {
// consentement analytique accordé
}
const unsubscribe = api?.onConsentChanged(consent => {
console.log('Consent changed', consent);
});
PrivacyKit expose l'API complète sur window.PrivacyKit.
window.PrivacyKit = {
onReady,
readConsent,
hasConsent,
onConsentChanged,
openConsentDialog,
onConsentDialogClosed,
openPrivacyPolicyDialog,
toggleComplianceMonitor,
getSubscriptionStatus,
subscriptionStatus,
};S'abonne à l'événement privacykit:ready lorsque l'API est disponible.
onReady(callback: () => void): () => voidwindow.PrivacyKit?.onReady(() => {
// Vous pouvez appeler l'API PrivacyKit en toute sécurité ici
const consent = window.PrivacyKit.readConsent();
// ...
});Lit le cookie de consentement courant et renvoie un objet normalisé.
readConsent(): {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null
Évalue le consentement pour une catégorie ou une expression.
hasConsent(expression?: string): booleanS'abonne aux mises à jour de consentement et renvoie une fonction de désinscription.
onConsentChanged(callback: (consent: {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null) => void): () => void
Ouvre le dialogue PrivacyKit par programmation.
openConsentDialog(): voidS'abonne aux événements de fermeture du dialogue.
onConsentDialogClosed(callback: () => void): () => voidOuvre la boîte de dialogue de politique de confidentialité par programmation en mode autonome et réutilise le style ainsi que le contenu des slots du consent-dialog déclaré.
openPrivacyPolicyDialog(): voidActive ou désactive le PrivacyKit Compliance Monitor. Lorsqu’il est activé, un bouton d’action flottant apparaît dans un coin de la page et donne accès à la boîte de dialogue du Monitor.
toggleComplianceMonitor(): voidRenvoie le statut d’abonnement actuel pour le domaine. Il s’agit d’un outil en lecture seule — l’abonnement et la facturation sont gérés automatiquement par PrivacyKit via Paddle.
getSubscriptionStatus(): {
status: string | null;
billingInterval: string | null;
subscriptionEnd: string | null;
trailingEnd: string | null;
} | null