Que peut faire l'API REST de Deskwoot ?

Mis à jour le 4 nov. 20264 min de lecture
Français
Sur cette page

L'API REST de Deskwoot vous donne un accès par code à vos données de support. Vous pouvez ainsi lire et créer des conversations, gérer vos contacts, envoyer et récupérer des messages, et relier Deskwoot à vos propres outils et scripts. C'est une fonctionnalité Enterprise, et chaque requête s'authentifie avec un jeton que vous créez dans Paramètres > Jetons d'API.

Que pouvez-vous faire avec l'API ?

L'API REST couvre les éléments que vous utilisez chaque jour dans votre helpdesk. Avec les bonnes autorisations sur le jeton, vous pouvez :

  • Conversations : lister, lire, créer et mettre à jour des conversations, et changer leur statut ou leur attribution.
  • Messages : récupérer les messages d'une conversation et publier de nouvelles réponses ou des notes privées.
  • Contacts : lire, créer et mettre à jour les personnes qui vous écrivent, y compris leurs attributs.
  • Tickets : créer un ticket à partir des messages d'une conversation, lire et modifier des tickets, répondre au client depuis un ticket dans la conversation d'où il vient, résoudre un chat et l'enregistrer comme ticket, et lister les catégories de tickets. Les tickets sont inclus dans le forfait Enterprise ; un administrateur peut les désactiver dans Paramètres > Tickets. Les listes, les décomptes et les rapports laissent les tickets de côté, sauf si vous les demandez avec type, si bien que les intégrations créées avant les tickets ne voient aucun changement.
  • Rapports : chaque chiffre de la page Rapports (volume, délais de première réponse et de résolution, CSAT) par agent, équipe, boîte de réception, canal, étiquette, statut, priorité, jour ou semaine, avec des filtres combinables et n'importe quelle période, ainsi que chaque conversation et chaque réponse CSAT sous forme de lignes ou en CSV.

L'API convient donc bien pour synchroniser des tickets avec un système interne, créer un tableau de bord sur mesure, automatiser des mises à jour courantes ou envoyer des données de conversation vers un autre outil.

Quel forfait inclut l'API REST ?

L'API REST est une fonctionnalité Enterprise, et les jetons d'API ne peuvent être créés qu'avec un forfait Enterprise payant. L'essai gratuit de 7 jours par lequel commence chaque nouveau compte n'inclut pas les jetons d'API : l'API REST ne fonctionne donc pas pendant l'essai. Si vous avez un forfait inférieur et avez besoin d'un accès à l'API, vous devrez passer à Enterprise.

Comment obtenir un jeton ?

Les jetons se créent et se gèrent dans Paramètres > Jetons d'API. Donnez à chaque jeton un nom clair, n'accordez que les autorisations dont l'intégration a besoin, et copiez-le dès qu'il est généré, car sa valeur complète risque de ne plus s'afficher. Consultez le guide des jetons d'API pour toutes les étapes, y compris l'URL de base et la façon de transmettre le jeton dans l'en-tête d'autorisation.

Et si je veux un agent IA plutôt que d'écrire du code ?

Si votre but est de laisser un agent IA externe gérer le helpdesk plutôt que d'écrire votre propre intégration, le serveur MCP peut mieux vous convenir. Il met un ensemble défini d'outils à la disposition d'un agent qui parle MCP, via un jeton de bot aux autorisations limitées. Comme l'API REST, c'est une fonctionnalité Enterprise. Pendant l'essai gratuit de 7 jours, un agent peut se connecter, mais seul whoami répond ; tous les autres outils nécessitent un forfait Enterprise payant.

Questions fréquentes

L'API REST est-elle disponible avec tous les forfaits ?
Non. L'API REST est une fonctionnalité Enterprise, et les jetons d'API nécessitent un forfait Enterprise payant. L'essai gratuit de 7 jours n'inclut pas les jetons d'API : l'API REST n'y fonctionne donc pas.
À quoi puis-je accéder avec l'API ?
Aux conversations, messages, contacts et tickets, entre autres données du helpdesk. Vous pouvez lire et créer des conversations, publier des réponses et des notes, traiter des tickets et gérer des contacts, toujours dans la limite des autorisations de votre jeton. La référence complète se trouve dans la documentation de l'API.
Où créer un jeton d'API ?
Dans Paramètres > Jetons d'API. Donnez un nom au jeton, n'accordez que les autorisations dont vous avez besoin, et copiez-le tout de suite, car sa valeur complète risque de ne plus s'afficher.
Dois-je utiliser l'API REST ou le serveur MCP ?
Utilisez l'API REST pour créer vos propres intégrations et scripts. Utilisez le serveur MCP si vous voulez qu'un agent IA externe gère le helpdesk via un jeton de bot aux autorisations limitées. Les deux sont des fonctionnalités Enterprise.
Puis-je afficher les rapports dans mon propre tableau de bord ?
Oui. Les endpoints de rapports renvoient les mêmes chiffres que la page Rapports, filtrés par agent, équipe, boîte de réception, canal, étiquette, statut et priorité sur n'importe quelle période, regroupés par agent, étiquette, jour, semaine et plus encore, ainsi que chaque conversation et chaque réponse CSAT sous forme de lignes. Appelez-les depuis votre propre serveur avec un jeton qui a l'autorisation conversations:read. La référence complète se trouve dans la documentation de l'API.

Ce guide vous a-t-il aidé ?

Continuer la lecture

Demander à Fynn à propos de ce guide

Obtenez une réponse courte tirée de ce guide et du reste du centre d'aide.

Besoin d'aide supplémentaire ?

Fynn répond dans le chat à partir de ces guides, et vous pouvez aussi y joindre l'équipe.

Écrivez-nous par e-mail