API REST
Les instructions ci-dessous s’appliquent uniquement aux ordinateurs de bureau et aux ordinateurs portables.
L’API REST de tawk.to vous permet d’automatiser et de gérer de nombreux aspects de votre compte, en simplifiant les tâches et en intégrant tawk.to à vos systèmes existants.
Vous pouvez utiliser l’API REST pour :
Créer des propriétés et inviter automatiquement des membres de l’équipe
Récupérer des listes filtrées de tickets, de discussions ou de membres de la propriété
Consulter les statistiques de discussion par agent, tag, département et date
Gérer les webhooks
Créer et lister des articles de la Base de connaissances
Créer et personnaliser des widgets de discussion
REMARQUE : L’API REST est conçue pour les développeurs ou toute personne à l’aise avec le code. Si vous découvrez les API, il est recommandé de travailler avec un développeur.
Pour des références techniques et des mises à jour, visitez le Portail Développeurs de tawk.to.
Pour en savoir plus sur l’utilisation des webhooks, consultez ce guide :
L’API REST est disponible sur demande. Pour commencer :
1. Remplissez le formulaire de demande d’accès à l’API REST.
2. Une fois votre demande approuvée, vous recevrez un nom d’utilisateur, un mot de passe et un lien vers la documentation de l’API REST.
Après avoir obtenu l’accès à l’API REST :
1. Connectez-vous à votre compte tawk.to.
2. Cliquez sur l’image de votre profil dans le coin inférieur gauche de votre Tableau de bord.
3. Cliquez sur Modifier le profil.
5. Cliquez sur Créer une clé.
6. Votre nouvelle clé apparaîtra dans la liste.
Important : Conservez votre clé API en lieu sûr. Ne la partagez pas avec des personnes non autorisées.
Pour supprimer une clé, sélectionnez-la et cliquez sur Supprimer.
Toutes les requêtes vers l’API REST doivent :
Utiliser HTTPS
Utiliser l’authentification HTTP Basic avec votre clé API comme nom d’utilisateur dans l’en-tête d’autorisation
La configuration dépend de votre client HTTP ou du langage de programmation utilisé. La plupart disposent d’un support intégré pour l’authentification Basic.
En savoir plus sur l’en-tête d’autorisation HTTP ici.
URL de base : https://api.tawk.to/v1/
L’API REST utilise des méthodes HTTP de style RPC. Transmettez les paramètres dans le corps des requêtes POST, sauf indication contraire dans la documentation.
Obtenir les détails de l’agent actuel
Point de terminaison : POST https://api.tawk.to/v1/agent.me
Authentification : HTTP Basic (clé API comme nom d’utilisateur)
Réponse : JSON avec un indicateur de succès ; les erreurs incluent un code d’erreur court.
Les requêtes réussies renvoient du JSON avec un indicateur de succès clair.
Si un problème survient, la réponse inclura un code d’erreur que vous pourrez utiliser pour diagnostiquer ou gérer le problème.
Consultez la documentation de votre API REST pour obtenir la liste complète des méthodes, paramètres et codes d’erreur.
Posez vos questions à notre communauté de développeurs si vous avez besoin d’aide concernant l’utilisation de notre API REST.
Sécurité
Stockez vos clés API en toute sécurité et renouvelez-les régulièrement.
Tests
Testez vos requêtes dans un environnement de préproduction avant d’apporter des modifications en production.
Gestion des erreurs
Prévoyez des tentatives avec délai en cas de problèmes temporaires.
Webhooks
Validez les données entrantes pour confirmer que les requêtes sont authentiques.
Alternatives
Si vous devez seulement personnaliser le widget sur votre site, l’API JavaScript peut être plus simple que l’API REST.
Si vous avez des retours sur cet article, ou si vous avez besoin d’aide supplémentaire :
- Cliquez sur l’icône verte du chat en direct
- Planifiez un appel avec nous
- Visitez notre communauté