Guia: ajuda e suporte dentro da sua aplicação
Passo a passo para que seu produto tenha um botão Ajuda com sua central de ajuda e um formulário Falar com o suporte que cria casos no Elion ITSM.
Nesta página
Este guia monta, no seu produto, o mesmo que o Argunis Monitoring tem:
um botão Ajuda que abre sua central de ajuda em um painel, na página que corresponde à tela onde o usuário está;
uma aba Falar com o suporte onde o usuário abre um caso, vê as respostas da equipe, responde e avalia o atendimento.
Tudo chega a uma mesa de serviço do Elion ITSM e sua equipe atende como qualquer ticket.
Antes de começar
A central de ajuda da sua empresa ativada, com sua documentação publicada. Leia Central de ajuda.
Uma mesa de serviço para o suporte, e ser o Líder dela.
Uma equipe de desenvolvimento que possa modificar seu produto (a parte do servidor e a da tela).
Passo 1. Autorizar seu produto a mostrar o espaço dele
No Elion ITSM, entre em Configurações → Central de ajuda, aba Site.
Em Espaços incluídos, na linha do espaço do seu produto, escreva o endereço dele em Mostrar em iframe a partir de, por exemplo
https://app.miproducto.cl, e clique em Salvar espaços.
Seu produto poderá mostrar só esse espaço, não a página inicial nem os outros espaços da central de ajuda.
Leia Mostrar a central de ajuda dentro de outro site.
Passo 2. O painel de Ajuda no seu produto
Sua equipe de desenvolvimento:
Adiciona um botão Ajuda que abre um painel lateral com um
iframeparahttps://<tu centro de ayuda>/<espacio>/<ruta>?embed=1. Com?embed=1aparecem só o conteúdo e o menu do espaço.Associa cada tela do seu produto ao caminho da sua página de ajuda. Sem caminho, abre a página inicial do espaço.
Adiciona um link Abrir em outra aba, com o mesmo endereço sem
?embed=1.Permite sua central de ajuda na política de segurança do seu produto (
frame-src).
Passo 3. Criar o canal de casos
Sua equipe de desenvolvimento cria no servidor do seu produto a URL que receberá os avisos, por exemplo
https://api.miproducto.cl/hooks/argunis-itsm.No Elion ITSM, na sua mesa de suporte, crie um canal com essa URL como URL de saída. Leia Canais de casos.
Entregue à sua equipe de desenvolvimento a URL do canal, o segredo de entrada e o segredo de saída. Eles são guardados como variáveis secretas do servidor do seu produto.
Passo 4. Falar com o suporte
Sua equipe de desenvolvimento, no servidor do seu produto (o navegador nunca fala com o Elion ITSM nem vê os segredos):
Formulário. Assunto, descrição, tipo (problema ou consulta), urgência e anexos. Adicione só o contexto útil (tela, versão, navegador), nunca senhas nem dados sensíveis.
Criar o caso. Gere um
externalId, guarde-o junto ao usuário e enviePOST {URL}/casesassinado, com o e-mail e o nome do usuário comorequestere a empresa dele comocompany. Leia Criar e acompanhar casos por API e Assinar as requisições.Meus casos. Mostre os casos do usuário com
stateLabele a conversa (publicMessages), como texto. Para atualizar um,GET {URL}/cases/{externalId}.Responder e anexos. As respostas vão para
POST {URL}/cases/{externalId}/replies; os anexos são baixados através do seu servidor.Receber avisos. Na URL de avisos, verifique a assinatura e atualize o caso a cada
case.reply,case.state,case.resolvedecase.closed, e avise o usuário dentro do seu produto. Leia Receber avisos por webhook.Pesquisa. Com
case.csat(oucsatPending: true), mostre a pesquisa de 1 a 5 e envie-a paraPOST {URL}/cases/{externalId}/csat.
Com URL de saída, o Elion ITSM não envia e-mails ao usuário: quem avisa é o seu produto. Se você preferir que ele também receba e-mails, pode enviá-los a partir do seu produto ao receber cada aviso.
Passo 5. Testar
No canal, clique em Testar saída e verifique em Ver entregas se aparece entregue.
Crie um caso pelo seu produto e confira se ele aparece na mesa, com origem API.
Responda como agente e confira se o usuário vê a resposta no seu produto.
Resolva o caso e confira se a pesquisa aparece.
Relacionado
API de conteúdo, se você preferir mostrar os artigos com seu design em vez do iframe.