Guide : aide et support dans votre application
Pas à pas pour que votre produit dispose d'un bouton Aide avec votre centre d'aide et d'un formulaire Contacter le support qui crée des dossiers dans Elion ITSM.
Sur cette page
Ce guide met en place dans votre produit ce dont dispose Argunis Monitoring :
un bouton Aide qui ouvre votre centre d'aide dans un panneau, sur la page correspondant à l'écran où se trouve l'utilisateur ;
un onglet Contacter le support où l'utilisateur ouvre un dossier, voit les réponses de l'équipe, répond et évalue le service.
Tout arrive dans un centre de services d'Elion ITSM et votre équipe le traite comme n'importe quel ticket.
Avant de commencer
Le centre d'aide de votre entreprise activé, avec votre documentation publiée. Lisez Centre d'aide.
Un centre de services pour le support, dont vous êtes Responsable.
Une équipe de développement capable de modifier votre produit (la partie serveur et la partie écran).
Étape 1. Autoriser votre produit à afficher son espace
Dans Elion ITSM, ouvrez Paramètres → Centre d'aide, onglet Site.
Dans Espaces inclus, sur la ligne de l'espace de votre produit, saisissez son adresse dans Afficher en iframe depuis, par exemple
https://app.miproducto.cl, et cliquez sur Enregistrer les espaces.
Votre produit ne pourra afficher que cet espace, ni l'accueil ni les autres espaces du centre d'aide.
Lisez Afficher le centre d'aide dans un autre site.
Étape 2. Le panneau d'aide dans votre produit
Votre équipe de développement :
Ajoute un bouton Aide qui ouvre un panneau latéral avec une
iframevershttps://<tu centro de ayuda>/<espacio>/<ruta>?embed=1. Avec?embed=1, seuls le contenu et le menu de l'espace s'affichent.Associe chaque écran de votre produit au chemin de sa page d'aide. Sans chemin, le panneau ouvre l'accueil de l'espace.
Ajoute un lien Ouvrir dans un autre onglet, avec la même adresse sans
?embed=1.Autorise votre centre d'aide dans la politique de sécurité de votre produit (
frame-src).
Étape 3. Créer le canal de dossiers
Votre équipe de développement crée sur le serveur de votre produit l'URL qui recevra les notifications, par exemple
https://api.miproducto.cl/hooks/argunis-itsm.Dans Elion ITSM, dans votre centre de services de support, créez un canal avec cette URL comme URL de sortie. Lisez Canaux de dossiers.
Transmettez à votre équipe de développement l'URL du canal, le secret d'entrée et le secret de sortie. Ils sont enregistrés comme variables secrètes du serveur de votre produit.
Étape 4. Contacter le support
Votre équipe de développement, sur le serveur de votre produit (le navigateur ne communique jamais avec Elion ITSM et ne voit jamais les secrets) :
Formulaire. Objet, description, type (problème ou question), urgence et pièces jointes. N'ajoutez que le contexte utile (écran, version, navigateur), jamais de mots de passe ni de données sensibles.
Créer le dossier. Générez un
externalId, conservez-le avec l'utilisateur et envoyezPOST {URL}/casessigné, avec l'e-mail et le nom de l'utilisateur commerequesteret son entreprise commecompany. Lisez Créer et suivre des dossiers par API et Signer les requêtes.Mes dossiers. Affichez les dossiers de l'utilisateur avec
stateLabelet la conversation (publicMessages), sous forme de texte. Pour en rafraîchir un,GET {URL}/cases/{externalId}.Répondre et pièces jointes. Les réponses vont vers
POST {URL}/cases/{externalId}/replies; les pièces jointes se téléchargent via votre serveur.Recevoir les notifications. Sur l'URL des notifications, vérifiez la signature et mettez à jour le dossier à chaque
case.reply,case.state,case.resolvedetcase.closed, puis prévenez l'utilisateur dans votre produit. Lisez Recevoir des notifications par webhook.Enquête. Avec
case.csat(oucsatPending: true), affichez l'enquête de 1 à 5 et envoyez-la àPOST {URL}/cases/{externalId}/csat.
Avec une URL de sortie, Elion ITSM n'envoie pas d'e-mails à l'utilisateur : c'est votre produit qui le prévient. Si vous préférez qu'il reçoive aussi des e-mails, vous pouvez les envoyer depuis votre produit à la réception de chaque notification.
Étape 5. Tester
Dans le canal, cliquez sur Tester la sortie et vérifiez dans Voir les livraisons que le statut est livré.
Créez un dossier depuis votre produit et vérifiez qu'il apparaît dans l'espace, avec l'origine API.
Répondez en tant qu'agent et vérifiez que l'utilisateur voit la réponse dans votre produit.
Résolvez le dossier et vérifiez que l'enquête apparaît.
Voir aussi
API de contenu, si vous préférez afficher les articles avec votre design plutôt que dans l'iframe.