Docs

Puesta en marcha

De cero a un consentimiento registrado y verificado en cinco pasos.

1. Entra en la consola

Abre la consola e inicia sesión. El primer inicio de sesión crea tu organización automáticamente, contigo como OWNER.

2. Crea un sitio

En Sites & API keysNew site. Asigna un nombre y un slug (minúsculas, guiones). Añade un dominio si vas a usar claves publicables (pk_) desde el navegador.

3. Crea una clave de API

En la misma pantalla → New key. Elige secret (sk_, servidor) o publishable (pk_, navegador, restringida por Origin) y el entorno test o live. La clave completa se muestra una sola vez: cópiala.

4. Publica un propósito

En Propósitos y cláusulasNew purpose, con una key (por ejemplo, marketing_email) y una categoría. Edita el texto legal (multiidioma) y publícalo. Todo consentimiento se registra contra una versión publicada.

5. Registra y consulta el consentimiento

curl -X POST $API/v1/consent \
  -H "authorization: Bearer sk_test_…" \
  -H "content-type: application/json" \
  -H "idempotency-key: $(uuidgen)" \
  -d '{"subject":"email:tu@ejemplo.com","purpose":"marketing_email","state":"GRANTED"}'

La respuesta incluye un receiptId. Consulta el estado con GET /v1/subjects/email:tu@ejemplo.com/consent y verás el propósito en GRANTED. En la consola, ve a Bóveda de consentimiento, busca email:tu@ejemplo.com y abre la cronología.

Para probar la API antes de montar un banner, puedes ejecutar cada endpoint /v1 directamente desde la referencia de la API con tu clave de test.