Getting Started

La Integration API es el contrato público, versionado y curado para integradores. Todas sus rutas comienzan con /v1. Las APIs administrativas, operacionales y del runtime interno del iframe no forman parte de este contrato.

Antes de comenzar

Necesitas una URL de API para el ambiente asignado, una API key de tenant y los scopes correspondientes a tu flujo. Conserva la API key exclusivamente en tu backend.

export CONSENSA_API_URL="https://api.sandbox.consensa.example"
export CONSENSA_API_KEY="<server-side-api-key>"

Todas las operaciones usan Bearer authentication:

Authorization: Bearer <server-side-api-key>
Content-Type: application/json

Primer flujo

1. Tu backend crea una Embed Session real mediante POST /v1/embed/sessions.
2. Entrega al frontend sólo el launchTicket de un solo uso y el sessionId; el componente los usa para iniciar el runtime.
3. El Web Component muestra la interacción desde el iframe Consensa-origin.
4. Tu frontend reacciona al evento público sanitizado.
5. Tu backend consulta el resultado definitivo con GET /v1/consent-interactions/{interactionId}.

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-01

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.