Esta página describe la API pública de JavaScript usada para leer el estado de consentimiento, reaccionar a cambios y controlar el flujo del diálogo desde tu aplicación.
Carga PrivacyKit globalmente antes de llamar a cualquier método del API.
<head>
<script type="module" src="https://cdn.privacykit.eu/v1/index.esm.js"></script>
...
</head>Todo acceso público pasa por el objeto global window.PrivacyKit, sin importar cómo se cargue el script.
const api = window.PrivacyKit;
if (api?.hasConsent('analytics')) {
// consentimiento de analítica concedido
}
const unsubscribe = api?.onConsentChanged(consent => {
console.log('Consent changed', consent);
});
PrivacyKit expone la API completa en window.PrivacyKit.
window.PrivacyKit = {
onReady,
readConsent,
hasConsent,
onConsentChanged,
openConsentDialog,
onConsentDialogClosed,
openPrivacyPolicyDialog,
toggleComplianceMonitor,
getSubscriptionStatus,
subscriptionStatus,
};Se suscribe al evento privacykit:ready cuando el API está disponible.
onReady(callback: () => void): () => voidwindow.PrivacyKit?.onReady(() => {
// Aquí puedes llamar con seguridad a los métodos del API de PrivacyKit
const consent = window.PrivacyKit.readConsent();
// ...
});Lee la cookie de consentimiento actual y devuelve un objeto normalizado.
readConsent(): {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null
Evalúa el consentimiento para una categoría o expresión.
hasConsent(expression?: string): booleanSe suscribe a cambios de consentimiento y devuelve una función para cancelar la suscripción.
onConsentChanged(callback: (consent: {
analytics: boolean;
marketing: boolean;
preferences: boolean;
} | null) => void): () => void
Abre el diálogo de PrivacyKit mediante código.
openConsentDialog(): voidSe suscribe a los eventos de cierre del diálogo.
onConsentDialogClosed(callback: () => void): () => voidAbre el diálogo de Política de privacidad mediante código en modo independiente y reutiliza el estilo y el contenido de slots del consent-dialog declarado.
openPrivacyPolicyDialog(): voidActiva o desactiva el PrivacyKit Compliance Monitor. Cuando está activado, aparece un botón de acción flotante en una esquina de la página y permite acceder al diálogo del Monitor.
toggleComplianceMonitor(): voidDevuelve el estado de suscripción actual del dominio. Es un ayudante de solo lectura — la suscripción y la facturación se gestionan automáticamente por PrivacyKit mediante Paddle.
getSubscriptionStatus(): {
status: string | null;
billingInterval: string | null;
subscriptionEnd: string | null;
trailingEnd: string | null;
} | null