Primeros pasos
Integra la Consensa Integration API v1 sin exponer credenciales en el navegador.
La Integration API es el contrato público, versionado y curado para integradores. Todas sus rutas empiezan con /v1. Las APIs administrativas, operacionales y del runtime interno del iframe no forman parte de este contrato.
Antes de empezar
Necesitas tres cosas:
- La URL de API del ambiente que te asignaron.
- Una API key de tenant, que vive exclusivamente en tu backend.
- Los scopes que requiere tu flujo (ver Autenticación).
export CONSENSA_API_URL="https://api.sandbox.consensa.example"
export CONSENSA_API_KEY="<api-key-de-tu-backend>"Todas las operaciones usan autenticación Bearer:
Authorization: Bearer <api-key-de-tu-backend>
Content-Type: application/jsonElige tu flujo
Casi toda integración empieza igual: tu backend crea una sesión y el Web Component de Consensa captura la decisión del titular en tu página.
| Quiero… | Empieza por |
|---|---|
| Capturar consentimientos generales en mi canal | Flujo de consentimiento general |
| Capturar consentimiento REDEC y consultar la CMF | Flujo REDEC |
| Dejar que el titular administre sus consentimientos | Centro de Privacidad |
| Saber si puedo tratar los datos ahora mismo | Autorización |
Las cuatro reglas que no cambian
La API key nunca llega al navegador. Todas las operaciones de esta referencia son servidor a servidor. Al frontend sólo le entregas el sessionId y un launchTicket de un solo uso que vence en 60 segundos.
Los eventos del navegador son para la interfaz, no para el negocio. El resultado canónico se confirma siempre desde tu backend con GET /v1/consent-interactions/{interactionId}.
Un error nunca es un permiso. Un timeout, un 5xx o una respuesta ausente jamás equivalen a consentimiento ni a autorización. Ver Errores.
El pre-chequeo no autoriza. Que POST /v1/embed/sessions responda presentation.required: false significa que no hace falta volver a preguntarle al titular, no que puedas tratar los datos. Para eso existe /v1/authorization/check.
Idempotencia
Las operaciones de escritura que declaran Idempotency-Key requieren una clave estable por intento semántico. Reutiliza la misma clave al reintentar el mismo comando y usa una nueva para una operación distinta.
Idempotency-Key: onboarding-customer-4821-01Reutilizar una clave con un cuerpo distinto responde 409. No cambies la clave para esquivar un conflicto: investiga por qué el cuerpo cambió.
Referencia exacta
La API Reference se genera desde el único documento OpenAPI 3.1. En local y sandbox permite probar requests; en producción esa función está deshabilitada para evitar el uso de credenciales productivas en el navegador.