Guía: ayuda y soporte dentro de tu aplicación
Paso a paso para que tu producto tenga un botón Ayuda con tu centro de ayuda y un formulario Contactar a soporte que crea casos en Elion ITSM.
En esta página
Esta guía arma, en tu producto, lo mismo que tiene Argunis Monitoring:
un botón Ayuda que abre tu centro de ayuda en un panel, en la página que corresponde a la pantalla donde está el usuario;
una pestaña Contactar a soporte donde el usuario abre un caso, ve las respuestas del equipo, responde y califica la atención.
Todo llega a una mesa de servicio de Elion ITSM y tu equipo lo atiende como cualquier ticket.
Antes de empezar
El centro de ayuda de tu empresa activado, con tu documentación publicada. Lee Centro de ayuda.
Una mesa de servicio para el soporte, y ser su Líder.
Un equipo de desarrollo que pueda modificar tu producto (la parte del servidor y la de la pantalla).
Paso 1. Autorizar tu producto a mostrar su espacio
En Elion ITSM, entra a Configuración → Centro de ayuda, pestaña Sitio.
En Espacios incluidos, en la fila del espacio de tu producto, escribe su dirección en Mostrar en iframe desde, por ejemplo
https://app.miproducto.cl, y presiona Guardar espacios.
Tu producto podrá mostrar solo ese espacio, no la portada ni los otros espacios del centro de ayuda.
Lee Mostrar el centro de ayuda dentro de otro sitio.
Paso 2. El panel de Ayuda en tu producto
Tu equipo de desarrollo:
Agrega un botón Ayuda que abre un panel lateral con un
iframehaciahttps://<tu centro de ayuda>/<espacio>/<ruta>?embed=1. Con?embed=1se ve solo el contenido y el menú del espacio.Asocia cada pantalla de tu producto con la ruta de su página de ayuda. Sin ruta, abre la portada del espacio.
Agrega un enlace Abrir en otra pestaña, con la misma dirección sin
?embed=1.Permite tu centro de ayuda en la política de seguridad de tu producto (
frame-src).
Paso 3. Crear el canal de casos
Tu equipo de desarrollo crea en el servidor de tu producto la URL que recibirá los avisos, por ejemplo
https://api.miproducto.cl/hooks/argunis-itsm.En Elion ITSM, en tu mesa de soporte, crea un canal con esa URL como URL de salida. Lee Canales de casos.
Entrega a tu equipo de desarrollo la URL del canal, el secreto de entrada y el secreto de salida. Se guardan como variables secretas del servidor de tu producto.
Paso 4. Contactar a soporte
Tu equipo de desarrollo, en el servidor de tu producto (el navegador nunca habla con Elion ITSM ni ve los secretos):
Formulario. Asunto, descripción, tipo (problema o consulta), urgencia y adjuntos. Agrega solo el contexto útil (pantalla, versión, navegador), nunca contraseñas ni datos sensibles.
Crear el caso. Genera un
externalId, guárdalo junto al usuario y envíaPOST {URL}/casesfirmado, con el correo y nombre del usuario comorequestery su empresa comocompany. Lee Crear y seguir casos por API y Firmar las peticiones.Mis casos. Muestra los casos del usuario con
stateLabely la conversación (publicMessages), como texto. Para refrescar uno,GET {URL}/cases/{externalId}.Responder y adjuntos. Las respuestas van a
POST {URL}/cases/{externalId}/replies; los adjuntos se descargan a través de tu servidor.Recibir avisos. En la URL de avisos, verifica la firma y actualiza el caso con cada
case.reply,case.state,case.resolvedycase.closed, y avisa al usuario dentro de tu producto. Lee Recibir avisos por webhook.Encuesta. Con
case.csat(ocsatPending: true), muestra la encuesta de 1 a 5 y envíala aPOST {URL}/cases/{externalId}/csat.
Con URL de salida, Elion ITSM no le envía correos al usuario: tu producto es quien le avisa. Si prefieres que también le lleguen correos, puedes enviarlos desde tu producto al recibir cada aviso.
Paso 5. Probar
En el canal, presiona Probar salida y revisa en Ver entregas que diga entregado.
Crea un caso desde tu producto y comprueba que aparece en la mesa, con origen API.
Responde como agente y comprueba que el usuario ve la respuesta en tu producto.
Resuelve el caso y comprueba que aparece la encuesta.
Relacionado
API de contenido, si prefieres mostrar los artículos con tu diseño en vez del iframe.