Point de terminaison de support personnalisé
Vue d’ensemble
Cet article explique comment connecter un point de terminaison de support personnalisé à Ferndesk. Cette fonctionnalité vous permet d’intégrer votre propre système de tickets ou de support, même s’il n’est pas pris en charge nativement par Ferndesk.
Prérequis
Vous devez disposer d’une URL accessible publiquement qui renvoie une réponse JSON.
Vous devez avoir les autorisations nécessaires pour gérer les intégrations dans Ferndesk.
Étapes
Accédez à la page Intégrations dans vos paramètres Ferndesk.
Cliquez sur le bouton « Ajouter une intégration ». Vous serez redirigé vers la page Connecter une intégration.
Sélectionnez « Point de terminaison de support » dans la liste des intégrations disponibles.
Dans la boîte de dialogue de configuration, vous verrez un champ intitulé « URL source ».
Saisissez l’URL de votre point de terminaison de support personnalisé. Le texte indicatif de ce champ est
https://company.com/support-endpoint.json?startDate=2025-01-01.Cliquez sur le bouton « Enregistrer » pour connecter le point de terminaison.
Une fois connecté, Ferndesk commencera à importer les conversations depuis votre point de terminaison afin d’identifier les lacunes de documentation et de suggérer des mises à jour.
Vérifier la configuration
Une fois connecté, vous pouvez vérifier que cela fonctionne correctement en créant un audit. Si la connexion réussit, vous devriez voir les conversations provenant de votre système de support personnalisé incluses dans l’audit.
Format JSON
Le point de terminaison de support personnalisé doit renvoyer une réponse JSON dans un format spécifique. L’objet racine doit contenir une clé conversations, qui contient un tableau d’objets de conversation. Chaque objet de conversation doit avoir un id, un horodatage lastMessageAt et un tableau de messages. Chaque objet message du tableau doit inclure un id, un role (soit user, soit c), un content et un horodatage createdAt.
Voici un exemple du format JSON attendu :
{
"conversations": [
{
"id": "conv_12345",
"url": "https://support.mycompany.com/conversations/12345",
"lastMessageAt": "2023-10-27T14:30:00Z",
"messages": [
{
"id": "msg_67890",
"role": "user",
"content": "Hello, I'm having trouble with...",
"createdAt": "2023-10-27T14:25:00Z"
},
{
"id": "msg_67891",
"role": "support_agent",
"content": "Hi there, I can help with that. Could you please provide...",
"createdAt": "2023-10-27T14:30:00Z"
}
]
}
]
}Si le format JSON est incorrect, les données ne seront pas ingérées. De plus, cette fonctionnalité ne prend actuellement pas en charge les points de terminaison authentifiés.
Dépannage
Format JSON incorrect : Vérifiez que la réponse JSON de votre point de terminaison correspond au format spécifié dans cet article.
URL invalide : Vérifiez que l’URL que vous fournissez est un point de terminaison accessible publiquement.
Authentification : Cette fonctionnalité ne prend actuellement pas en charge les points de terminaison authentifiés.
Pour améliorer la fiabilité de votre point de terminaison de support personnalisé, nous vous recommandons ce qui suit :
Implémentez un bouton « Test » dans votre système afin de vérifier que le point de terminaison est joignable et que la réponse JSON est valide avant d’enregistrer l’intégration.
Ajoutez des messages d’erreur plus explicites pour vous aider à résoudre les problèmes liés à votre point de terminaison, tels qu’une URL inaccessible, une réponse JSON invalide ou des échecs d’authentification.