L'API publique de Chatway vous permet de connecter vos applications et services à Chatway.
Grâce à l'API, vous pouvez gérer vos contacts, accéder aux conversations et envoyer des messages sans passer par le tableau de bord Chatway. Votre système peut envoyer des requêtes directement à Chatway pour automatiser ces actions. Ceci est particulièrement utile si vous souhaitez connecter Chatway à des outils tels que :
- Les CRM
- Plateformes de commerce électronique
- Outils d'assistance à la clientèle
Et plus encore.
Cette fonctionnalité de Chatway est payante, mais reste accessible pendant la période d'essai gratuite. Veuillez noter que si une clé API est créée durant cette période, elle sera révoquée dès que vous passerez à la version gratuite.
Veuillez consulter la documentation officielle de l'API de Chatway ici.
Que pouvez-vous faire avec l'API Chatway ?
Vous pouvez utiliser l'API Chatway pour automatiser les flux de travail de chat courants. Exemples :
• Création et mise à jour des contacts des visiteurs
• Récupérer les conversations et les messages de chat
• Envoi de messages depuis votre système
• Résolution automatique des conversations
• Synchronisation des données de chat avec des outils externes tels que les CRM
Cela vous permet d'intégrer Chatway à vos systèmes et flux de travail existants.
Générer une clé API dans Chatway
Pour utiliser l'API, vous devez d'abord créer une clé API. Pour la générer :
Étape 1 : Ouvrez le tableau de bord Chatway et cliquez sur « Paramètres » :
Veuillez noter que seuls les administrateurs et les propriétaires peuvent générer des clés API.
Étape 2 : Cliquez sur « Outils de développement ».
Étape 3 : Cliquez ici sur « Générer une clé API » et donnez un nom à votre clé API à l’étape suivante.
Étape 4 : Après avoir créé une clé, assurez-vous de la copier et de la stocker en lieu sûr.
Chatway n'affichera la clé API complète qu'une seule fois, lors de sa création. Une fois créée, seule une partie apparaîtra dans votre tableau de bord. Par exemple :
Limites importantes :
• Vous pouvez avoir jusqu'à 5 clés API actives
• Vous pouvez révoquer les clés à tout moment
Les clés révoquées ne peuvent pas être restaurées.
Authentification des requêtes API
Chaque requête API doit inclure votre clé API dans l'en-tête de la requête. Par exemple :
Clé API X : votre_clé_API_ici
Si la clé API est manquante ou invalide, la requête ne sera pas traitée. Une erreur 401 (Non autorisé) sera renvoyée. Par exemple :
URL de base
Toutes les requêtes API Chatway utilisent l'URL de base suivante :
https://developers.chatway.app/api/v1Exemples d'URL de requêtes possibles :
https://developers.chatway.app/api/v1/contacts (lists contacts)Limites de taux
Pour garantir des performances optimales, l'API Chatway limite le nombre de requêtes. Pour les abonnements payants, cette limite est de 60 requêtes par minute. Si votre application dépasse cette limite, les requêtes supplémentaires pourront être temporairement bloquées.
Domaines principaux de l'API
L'API Chatway est organisée en plusieurs domaines principaux.
Contacts
L'API Contacts vous permet de gérer les informations des visiteurs. Voici quelques exemples d'utilisation :
| Action | Endpoint | Exemple d'utilisation |
| Créer un contact | POST | Ajouter un nouveau visiteur lorsqu'une personne s'inscrit sur votre site. |
| Contact de mise à jour | PATCH | Mettre à jour les informations des visiteurs lorsqu'ils modifient leur adresse e-mail ou leur forfait. |
| Obtenir un contact | GET | Récupérer le profil complet et l'historique des conversations d'un utilisateur. |
| Liste de contacts | GET | Récupérez tous vos contacts depuis Chatway. |
Conversations
L'API Conversations vous permet d'accéder aux conversations et de les gérer. Voici quelques exemples d'utilisation :
| Action | Endpoint | Exemple d'utilisation |
| Liste de conversations | GET | Afficher les conversations Chatway dans le tableau de bord CRM. |
| Recevoir les messages d'une conversation | GET | Récupérer l'historique complet d'une conversation |
| Résoudre la conversation | POST | Résolution automatique des conversations lorsque le ticket est fermé dans un autre système. |
Messages
L'API Messages permet à votre système d'envoyer des messages via Chatway, tels que :
• Confirmations de commande
• Avis d'expédition
• Mises à jour du support
Par exemple :
| Action | Endpoint | Exemple d'utilisation |
| Envoyer | POST | Envoyez un message de remerciement une fois la commande terminée. |
De plus, vous pouvez également manipuler les widgets et les données des agents à l'aide de l'API Chatway.
Gestion des erreurs
En cas d'échec d'une requête, l'API renvoie une réponse d'erreur avec un code d'état. Voici quelques codes d'état courants :
• 200 — Requête réussie
• 201 — Ressource créée avec succès
• 401 — Requête non autorisée
• 404 — Ressource introuvable
• 422 — Erreur de validation
Consultez le corps de votre réponse pour obtenir des détails supplémentaires sur l'erreur.
Référence de l'API
Ce guide offre une vue d'ensemble de l'API Chatway.
Pour obtenir tous les détails techniques, y compris les paramètres de requête, les exemples de réponse et les définitions de schéma, veuillez vous référer à la documentation de l'API Chatway.