Jetons d'API et accès pour les développeurs
Sur cette page
Les jetons d'API permettent à du code ou à des scripts de communiquer avec votre compte Deskwoot sans utiliser de mot de passe. Vous en générez un par intégration (une synchronisation CRM, un tableau de bord sur mesure, un outil interne) et vous lui donnez uniquement les autorisations dont cette intégration a vraiment besoin. Vous pouvez révoquer un jeton à tout moment ; la révocation est immédiate et n'affecte aucun autre jeton. L'URL de base est https://api.deskwoot.com/v1/ et l'en-tête d'authentification est Authorization: Bearer YOUR_TOKEN. L'accès à l'API est réservé au forfait Enterprise ; les jetons déjà créés sur d'anciens forfaits continuent de fonctionner jusqu'à leur expiration.
Deskwoot propose une API REST qui vous donne un accès par programmation à vos données et à vos workflows de support. Que vous créiez des intégrations sur mesure, synchronisiez les données des tickets avec vos outils internes ou automatisiez des tâches répétitives, les jetons d'API vous permettent de vous authentifier en toute sécurité sans partager vos identifiants de connexion. Ce guide vous explique comment générer des jetons, faire votre premier appel à l'API et suivre les bonnes pratiques qui protègent votre compte.
L'API REST est une fonctionnalité Enterprise. L'essai Enterprise de 7 jours, par lequel commence chaque nouveau compte, n'inclut pas les jetons d'API ; il vous faut un forfait Enterprise actif pour les créer et les utiliser. Si vous êtes sur un forfait inférieur et avez besoin de l'accès à l'API, vous devrez passer au forfait Enterprise. Pour une vue plus complète de ce que couvre l'API, consultez la présentation de l'API REST.
Comment générer un jeton d'API ?
- Connectez-vous à votre compte Deskwoot et allez dans Paramètres > Jetons d'API.
- Cliquez sur Créer un jeton. Seuls les administrateurs peuvent créer des jetons.
- Donnez au jeton un nom parlant (par exemple Synchro CRM, production) pour retrouver plus tard à quoi il sert.
- Sélectionnez les autorisations précises que le jeton doit avoir. N'accordez que les niveaux d'accès dont votre intégration a vraiment besoin. Vous pouvez aussi choisir une date d'expiration.
- Confirmez et copiez le jeton tout de suite. Pour des raisons de sécurité, le jeton complet ne s'affiche qu'une seule fois.
Comment utiliser l'API ?
Toutes les requêtes à l'API se font sur l'URL de base suivante :
https://api.deskwoot.com/v1/
Ajoutez votre jeton d'API dans l'en-tête Authorization de chaque requête :
Authorization: Bearer YOUR_TOKEN
Exemple de requête
Un simple appel cURL pour tester votre connexion peut ressembler à ceci :
curl -H "Authorization: Bearer YOUR_TOKEN" https://api.deskwoot.com/v1/me
Si le jeton est valide, l'API renvoie l'ID de votre compte et les autorisations du jeton. Sinon, vous recevez une erreur d'authentification. La référence complète des endpoints se trouve dans la documentation de l'API.
Quelles sont les bonnes pratiques ?
- Accordez le moins d'accès possible. Donnez à chaque jeton uniquement les autorisations dont il a besoin. Évitez de créer des jetons avec un accès administrateur complet, sauf si vous en avez vraiment besoin.
- Renouvelez les jetons régulièrement. Révoquez de temps en temps les anciens jetons et générez-en de nouveaux, surtout quand des membres de l'équipe changent de rôle ou partent.
- Stockez les jetons en lieu sûr. Gardez-les dans des variables d'environnement ou un gestionnaire de secrets. Ne les écrivez jamais en dur dans du code côté client et ne les ajoutez jamais à votre système de gestion de versions.
- Utilisez des noms parlants. Nommer chaque jeton d'après l'intégration ou l'environnement qu'il sert facilite les vérifications.
- Surveillez l'utilisation. Passez régulièrement en revue vos jetons actifs dans Paramètres > Jetons d'API et supprimez ceux qui ne servent plus.
Comment résoudre les erreurs de jeton ?
- 401 Unauthorized : Vérifiez que le jeton a été copié correctement, qu'il n'a pas été révoqué et qu'il figure dans l'en-tête avec le préfixe
Bearer. - 403 Forbidden : Le jeton n'a peut-être pas les autorisations pour l'endpoint que vous appelez. Créez un nouveau jeton avec les bonnes autorisations et révoquez l'ancien. Une erreur 403 apparaît aussi quand l'espace de travail n'est plus sur le forfait Enterprise.
- Limite de requêtes : Si vous recevez des erreurs de limite de requêtes, appelez l'API moins souvent ou ajoutez à votre code de nouvelles tentatives avec un délai exponentiel.
Questions fréquentes
Et si je préfère qu'un agent IA utilise le helpdesk ?
Où créer un jeton d'API ?
Quelles autorisations sont disponibles ?
Que se passe-t-il si je perds un jeton ?
Quels forfaits donnent accès à l'API ?
Puis-je limiter un jeton à une seule boîte de réception ou à une seule équipe ?
Les jetons sont-ils liés à un utilisateur ou à un compte ?
Comment renouveler les jetons en toute sécurité, sans interruption ?
L'API compte-t-elle dans mon quota de conversations IA ?
Puis-je utiliser l'API depuis le navigateur ?
Puis-je définir une date d'expiration pour un jeton ?
Puis-je recevoir des webhooks au lieu d'interroger l'API en boucle ?
L'API REST est-elle disponible sur tous les forfaits ?
Puis-je créer plusieurs jetons d'API ?
Que se passe-t-il si mon jeton est compromis ?
Où créer un jeton ?
Ce guide vous a-t-il aidé ?
Continuer la lecture
- Importer depuis FreshdeskTransférez vers Deskwoot chaque ticket, contact et article de la base de connaissances Freshdesk. Les dossiers qui n'étaient pas publics restent internes.Lire le guide
- Supprimer votre compteComment supprimer votre compte Deskwoot et ce qu'il advient de vos donnéesLire le guide
- Importer depuis IntercomTransférez vers Deskwoot les conversations, les contacts et toutes les collections du centre d'aide d'Intercom avec un seul jeton d'accès.Lire le guide
Demander à Fynn à propos de ce guide
Obtenez une réponse courte tirée de ce guide et du reste du centre d'aide.