API do Aura Home SDK | Cadisa Systems

Opções, métodos e eventos de ciclo de vida públicos do lado do cliente para incorporar o Aura Home.

Inicialização

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"
  }
});

Opção	Obrigatória	Finalidade
`container`	Sim	Seletor CSS ou HTMLElement onde o iframe é montado.
`baseUrl`	Sim	URL do runtime do Aura Home a ser aberta.
`sdkHost`	Não	Rótulo legível do host para telemetria.
`allowedOrigin`	Não	Origem explícita do runtime para mensagens do navegador.
`sections`	Não	Controla as áreas visíveis do Aura Home.
`theme`	Não	Solicitação de tema nomeado, modo, variáveis CSS e personalização opcional da folha de estilo.
`auth`	Não	Callback de token para autenticação corporativa.
`dimensions`	Não	Dimensionamento do iframe.

Use baseUrl para selecionar o tenant e o ambiente. Não use tenantId como limite de isolamento, roteamento, autorização, faturamento ou residência de dados.

Seções

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"
}

O runtime aplica theme.id somente quando o tema é permitido para aquele runtime. Os operadores também podem publicar temas, tokens dos cards de resultado e metadados de aparência versionados por meio do Appearance Editor do dashboard. Consulte Aparência e temas.

Autenticação corporativa

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

Os tokens são enviados somente depois que o runtime incorporado solicita um. Não coloque tokens em query strings, CSS, atributos HTML locais ou logs.

Métodos de instância

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

Aparência resolvida

O SDK expõe o contrato de aparência resolvido e não sigiloso depois que o runtime aplica os padrões do tenant, os valores de tema solicitados e as configurações publicadas pelo dashboard.

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	Finalidade
`resolvedThemeId`	O perfil visual efetivamente aplicado pelo runtime.
`features.resultCardsEnabled`	Indica se a renderização enriquecida dos cards de resultado está ativa para o runtime atual.
`rendererCatalog`	Metadados públicos de renderizadores que o host pode usar para suporte e diagnóstico.
`cardTokens`	Tokens resolvidos de destaque, ação, superfície e anel de foco dos cards.
`themeRevision`	Informações da revisão de aparência publicada, para auditoria e suporte.

Eventos de ciclo de vida

Evento	Significado
`loaded`	O evento load do iframe foi disparado.
`ready`	O runtime incorporado anunciou que está pronto.
`appearanceResolved`	O runtime resolveu metadados de aparência não sigilosos, como o estado do recurso de cards de resultado, o catálogo de renderizadores, os tokens dos cards e a revisão de tema ativa.
`configAck`	O runtime aceitou a configuração do SDK.
`tokenProvided`	O SDK enviou um token de autenticação ao runtime.
`profileOpened`	O método `openProfile()` foi chamado.
`chatOpened`	O método `openChat()` foi chamado.
`error`	O runtime relatou um erro.
`destroyed`	A instância do SDK foi destruída.