API del Aura Home SDK | Cadisa Systems

Opciones, métodos y eventos del ciclo de vida públicos del lado del cliente para integrar Aura Home.

Inicialización

AuraHome.init({
  container: "#aura-home",
  baseUrl: "https://your-aura-home-runtime.example/",
  sdkHost: "customer.example",
  allowedOrigin: "https://your-aura-home-runtime.example",
  dimensions: {
    width: "100%",
    height: "720px",
    minHeight: "640px"
  }
});

Opción	Obligatoria	Propósito
`container`	Sí	Selector CSS o HTMLElement donde se monta el iframe.
`baseUrl`	Sí	URL del runtime de Aura Home que se abrirá.
`sdkHost`	No	Etiqueta legible del sitio anfitrión para la telemetría.
`allowedOrigin`	No	Origen explícito del runtime para la mensajería del navegador.
`sections`	No	Controla las áreas visibles de Aura Home.
`theme`	No	Solicitud de tema por nombre, modo, variables CSS y personalización opcional de la hoja de estilo.
`auth`	No	Callback de token para la autenticación empresarial.
`dimensions`	No	Tamaño del iframe.

Use baseUrl para seleccionar el tenant y el entorno. No use tenantId como límite de aislamiento, enrutamiento, autorización, facturación ni residencia de datos.

Secciones

sections: {
  chat: true,
  profile: true,
  exploreTools: false,
  navbar: false,
  footer: false,
  onboarding: false,
  pricing: false,
  legalPages: false
}

Temas

theme: {
  id: "cadisa",
  mode: "dark",
  cssVariables: {
    "--color-brand-primary": "#2F6FED",
    "--color-brand-primary-hover": "#1F56C6",
    "--color-brand-accent": "#8AB4F8",
    "--aura-chat-header-background": "#0b1f4d",
    "--aura-chat-message-font-size": "15px",
    "--aura-chat-button-font-weight": "700",
    "--aura-card-accent": "#2F6FED",
    "--aura-card-action-background": "#2F6FED",
    "--aura-card-focus-ring": "#8AB4F8"
  },
  stylesheetUrl: "https://customer.example/aura-home-theme.css"
}

El runtime aplica theme.id solo cuando el tema está permitido para ese runtime. Los operadores también pueden publicar temas, tokens de tarjetas de resultados y metadatos de apariencia con control de revisiones desde el Appearance Editor del panel. Consulte Apariencia y temas.

Autenticación empresarial

auth: {
  mode: "oidc",
  getToken: async () => {
    return await customerIdentity.getIdToken();
  }
}

Los tokens se envían solo después de que el runtime integrado solicita uno. No incluya tokens en cadenas de consulta, CSS, atributos HTML locales ni registros.

Métodos de instancia

instance.updateConfig({ sections: { profile: false } });
instance.openChat();
instance.openProfile();
instance.getResolvedAppearance();
instance.hide();
instance.show();
instance.destroy();

Apariencia resuelta

El SDK expone el contrato de apariencia resuelto y no secreto después de que el runtime aplica los valores predeterminados del tenant, los valores del tema solicitado y la configuración publicada desde el panel.

const appearance = instance.getResolvedAppearance();

instance.on("appearanceResolved", (event) => {
  console.log(event.payload?.resolvedThemeId);
  console.log(event.payload?.features?.resultCardsEnabled);
  console.log(event.payload?.themeRevision);
});

Campo	Propósito
`resolvedThemeId`	El perfil visual que el runtime aplica efectivamente.
`features.resultCardsEnabled`	Indica si la representación enriquecida de tarjetas de resultados está activa en el runtime actual.
`rendererCatalog`	Metadatos públicos de los renderizadores que el sitio anfitrión puede usar para soporte y diagnóstico.
`cardTokens`	Tokens resueltos de acento, acción, superficie y anillo de foco de las tarjetas.
`themeRevision`	Información de la revisión de apariencia publicada, para auditoría y soporte.

Eventos del ciclo de vida

Evento	Significado
`loaded`	Se disparó el evento de carga del iframe.
`ready`	El runtime integrado anunció que está listo.
`appearanceResolved`	El runtime resolvió los metadatos de apariencia no secretos, como el estado de la función de tarjetas de resultados, el catálogo de renderizadores, los tokens de tarjeta y la revisión de tema activa.
`configAck`	El runtime aceptó la configuración del SDK.
`tokenProvided`	El SDK envió un token de autenticación al runtime.
`profileOpened`	Se llamó a `openProfile()`.
`chatOpened`	Se llamó a `openChat()`.
`error`	El runtime informó un error.
`destroyed`	Se destruyó la instancia del SDK.