Documentación
Inicio rápido y conceptos.
Esta página contiene los fragmentos de código más importantes para integrar SimpleCMP.
La referencia completa de la API vive en el repositorio, en
docs/ — la implementación está en fase pre-1.0 y
todavía está cambiando.
Instalación
Dos vías: como paquete npm para pipelines de compilación, o como etiqueta de script IIFE para sitios estáticos y escenarios drop-in.
Paquete npm
# con pnpm
pnpm add simplecmp
# o con npm
npm install simplecmp
Drop-in IIFE (autoalojado)
Por motivos de privacidad, no distribuimos SimpleCMP a través de CDN públicas.
Coloca el bundle en tu propio directorio assets/ — para consultar las instrucciones completas,
véase Instalación en página estática.
<link rel="stylesheet" href="/assets/vendor/simplecmp/default.css">
<script src="/assets/vendor/simplecmp/simplecmp.global.js"></script>
<script>
SimpleCMP.init({ /* config */ });
</script>
Inicio rápido
Configuración mínima con dos servicios. Los enlaces de privacidad y aviso legal van por separado — importante para el mercado alemán (TMG/MStV).
import { init } from 'simplecmp';
init({
storageName: 'simplecmp-myapp',
privacyPolicy: 'https://example.com/datenschutz',
imprint: 'https://example.com/impressum',
floatingTrigger: { label: 'Cookie-Einstellungen' },
services: [
{
name: 'analytics',
title: 'Google Analytics',
purposes: ['analytics'],
cookies: [/^_ga/, '_gid'],
required: false,
default: false
},
{
name: 'matomo',
title: 'Matomo',
purposes: ['analytics'],
cookies: ['_pk_id', '_pk_ses'],
required: false,
default: false
}
]
});
Modo headless
¿Solo necesitas la máquina de estados y no el banner? La subruta del engine prescinde de los componentes Lit y es considerablemente más pequeña.
import { getManager, addEventListener } from 'simplecmp/engine';
const manager = getManager({
storageName: 'simplecmp-spa',
services: [/* ... */]
});
addEventListener('saveConsents', (consents) => {
console.log('Consent-State:', consents);
// actualiza aquí tu propia UI
});
// Desde tu propio banner:
manager.updateConsent('analytics', true);
manager.saveConsents();
Activar el recorder
En la compilación de desarrollo o de staging, activa el recorder antes de la primera
llamada a init(). Atención: no lo uses en producción sin una tasa de muestreo.
import { init } from 'simplecmp';
import { startRecorder } from 'simplecmp/recorder';
startRecorder({
serviceDB: 'https://library.simplecmp.eu',
onUnknown: (item) => console.warn('Unknown:', item),
onKnown: (item, service) => console.log('Found:', service.name)
});
init({ services: [] });
// Tras unos minutos de clics:
recorder.exportConfig();
// → { services: [ { name: 'ga', cookies: [...] }, ... ] }
// En CI:
recorder.assertNoUnknown(); // lanza una excepción con elementos desconocidos
Configurar el CMS-Bridge
Para producción: SimpleCMP hace POST a tu webhook cada vez que detecta algo desconocido. La tasa de muestreo evita inundaciones de webhooks cuando hay mucho tráfico.
import { init } from 'simplecmp';
init({
services: [/* ... */],
bridge: {
url: 'https://example.com/api/simplecmp/webhook',
secret: window.SCMP_PUBLIC_NONCE, // nonce, no secreto
sampleRate: 0.05, // 5 % de los visitantes
dedupTTL: 3600 // segundos
}
});
El esquema v2 del webhook está documentado en docs/cms-bridge-webhook.md.
Hay un receptor Node.js en demos/cms-bridge-receiver.mjs.
Integrar WordPress sin plugin
El plugin de WordPress está disponible como beta.
Si quieres trabajar sin plugin, integra SimpleCMP manualmente en cada tema de WordPress. En
functions.php:
function mytheme_enqueue_simplecmp() {
// Bundle antes con `composer require` o manualmente
// copiar en wp-content/themes/<theme>/assets/vendor/simplecmp/.
wp_enqueue_style(
'simplecmp',
get_template_directory_uri() . '/assets/vendor/simplecmp/default.css'
);
wp_enqueue_script(
'simplecmp',
get_template_directory_uri() . '/assets/vendor/simplecmp/simplecmp.global.js',
array(), null, false
);
$config = array(
'storageName' => 'simplecmp-' . sanitize_title(get_bloginfo('name')),
'privacyPolicy' => get_permalink(get_option('wp_page_for_privacy_policy')),
'imprint' => get_permalink(get_page_by_path('impressum')),
'services' => apply_filters('simplecmp_services', array())
);
wp_add_inline_script(
'simplecmp',
'SimpleCMP.init(' . wp_json_encode($config) . ');'
);
}
add_action('wp_enqueue_scripts', 'mytheme_enqueue_simplecmp');
Señales de consentimiento del navegador
SimpleCMP tiene en cuenta la señal Global Privacy Control
(Sec-GPC: 1) y la cabecera DNT heredada. El comportamiento predeterminado
es el rechazo automático; se puede cambiar mediante configuración.
init({
consentSignals: {
gpc: 'auto-decline', // o 'hide-banner' | 'confirm'
dnt: 'ignore' // DNT está de facto obsoleto
},
services: [/* ... */]
});
Más documentación
La documentación completa y todos los ADR (Architectural Decision Records) están en el repositorio de GitHub:
¿Necesitas ayuda?
Soporte de integración directamente de los mantenedores.
En WapplerSystems usamos SimpleCMP a diario en proyectos de clientes. Si necesitas apoyo con la implementación, el theming o una extensión a medida, estaremos encantados de ayudarte.