DocumentaciónAjuda

Mostrar a central de ajuda dentro de outro site

Autorize seu produto ou seu site a mostrar a central de ajuda dentro da própria página, em um iframe e sem a marca nem o rodapé.

Nesta página

Por segurança, a central de ajuda não pode ser mostrada dentro da página de outro site. Se você quer que seu produto mostre um espaço em um painel ou uma janela (um iframe), autorize o endereço do seu produto nesse espaço.

A autorização é por espaço: se a sua central de ajuda tem vários espaços (por exemplo, um por produto), cada produto pode mostrar só o seu. A página inicial da central de ajuda e os demais espaços não podem ser mostrados a partir desse site.

Antes de começar

  • Você precisa do nível de administrador em Configurações (função Administrador).

  • A central de ajuda deve estar ativada e o espaço, incluído. Leia Marca e espaços da central de ajuda.

Autorizar um site em um espaço

  1. Entre em Configurações → Central de ajuda e abra a aba Site.

  2. No cartão Espaços incluídos, procure a linha do espaço.

  3. Na coluna Mostrar em iframe a partir de, escreva o endereço do seu produto, por exemplo https://app.miproducto.cl. Um por linha, até 10.

  4. Clique em Salvar espaços.

Escreva só o começo do endereço: https:// e o domínio, sem caminhos. Os sites que não estiverem na lista do espaço não podem mostrá-lo.

Mostrar só o conteúdo

Adicione ?embed=1 ao endereço do iframe, por exemplo https://ayuda.miempresa.cl/manual/primeros-pasos?embed=1. Dentro do iframe:

  • aparecem só o conteúdo e o menu desse espaço, sem o logo, o rodapé nem os outros espaços;

  • a busca procura só nesse espaço;

  • se uma página tiver link para outro espaço ou para a página inicial, ele abre em uma aba nova, fora do seu produto.

Tema e idioma

  • Tema: adicione &theme=dark ou &theme=light ao endereço para que a central de ajuda use o mesmo tema do seu produto. Se o usuário mudar o tema com a ajuda aberta, seu produto pode avisar o iframe com iframe.contentWindow.postMessage({ type: 'ultrion-help-theme', theme: 'dark' }, 'https://<tu centro de ayuda>') e o tema muda sem recarregar.

  • Idioma: se você tem o manual em vários idiomas, cada idioma é um espaço (por exemplo, /manual, /manual-en, /manual-pt). Escolha o Idioma de cada espaço em Espaços incluídos: o menu, a busca e os textos da central de ajuda aparecem nesse idioma. Seu produto abre o espaço do idioma do usuário.

  • Qualquer site: se o seu produto é instalado em endereços que você não conhece (por exemplo, instalações nos servidores dos seus clientes), escreva https: em Mostrar em iframe a partir de: qualquer site https poderá mostrar esse espaço.

Fora do iframe, adicione um link Abrir em outra aba com o mesmo endereço sem ?embed=1, para quem quiser ler com mais espaço.

O que acontece depois

As mudanças valem para todas as páginas da central de ajuda em alguns minutos.

Relacionado

Pesquisar em Elion ITSM

Digite pelo menos 2 letras para pesquisar em Elion ITSM.

↑↓ navegar · Enter abrir · Esc fechar