Intégration API
Le composant additionnel API Pumble simplifie l’interaction avec l’API Pumble en éliminant les processus d’authentification compliqués. Grâce à cet ajout, les utilisateurs peuvent générer facilement des clés API, leur permettant ainsi d’utiliser de simples requêtes HTTP pour envoyer des messages, des réactions, et d’autres actions. Pour commencer, suivez ces étapes :
- Cliquez sur le bouton +Ajouter des applis en bas de la barre latérale gauche
- Cliquez sur Installer à côté de l'appli API
Un nouvel onglet s'ouvrira avec le formulaire de consentement et les spécificités de l'intégration.
L’appli pourrait déjà être installée sur votre espace de travail par un autre utilisateur. Vous devez l’autoriser pour l’utiliser en cliquant sur le bouton Autoriser à côté de son nom. - Sélectionnez l'espace de travail dans la liste déroulante
Il est important que vous soyez connecté à l'espace de travail Pumble que vous avez choisi dans la liste déroulante. - Cliquez sur Autoriser pour terminer l'installation
Commandes valides #
Il existe quelques actions spécifiques qui peuvent être utilisées pour interagir avec l'intégration de l'API sur Pumble :
/api-keys generate– Le composant additionnel génère des clés API pour l’utilisateur concerné et les stocke dans sa base de données. Les utilisateurs peuvent générer autant de clés API qu’ils le souhaitent./api-keys list– Le composant additionnel va lister toutes les clés API de l’utilisateur./api-keys help– Pour lister toutes les commandes valides que vous pouvez utiliser.
Générer des clés API #
Pour générer une clé API, procédez comme suit :
- Tapez /api-keys generate dans l'éditeur de messages de n'importe quel canal (vous pouvez également ajouter une note à côté)
- Appuyez sur le bouton Entrée/Envoyer pour terminer l'action
Vous recevrez une clé API dans un message éphémère (invisible pour les autres utilisateurs). Copiez cette clé pour interagir avec l’API publique du composant additionnel, permettant d’envoyer des demandes et d’exécuter diverses actions dans Pumble, entre autres :
- Envoyer des messages
- Laisser une réponse à un message
- Supprimer un message
- Ajouter une réaction à un message
- Créer un canal
- Lister les messages dans un canal (si le canal est privé, le module bot doit être membre de ce canal)
- Lister des canaux et DMs appartenant à l'utilisateur qui a créé la clé
The full list of available actions can be viewed in the Swagger documentation.
L’intégration API permet d’informer, par exemple, votre équipe de support client en temps réel des nouvelles commandes d’un site e-commerce actif. En intégrant Pumble à l’API, un système de notification automatisé alerte l’équipe via les canaux Pumble à chaque nouvelle commande.
Interagir avec l’API publique de module complémentaire #
Vous pouvez interagir avec l'API publique du composant additionnel pour envoyer des messages et effectuer d'autres actions dans Pumble en utilisant la clé API générée.
To do this, you need to send a request via an API platform (e.g., Insomnia, Postman, JMeter).
For the full suite of the supported APIs, see the documentation here. https://pumble-api-keys.addons.marketplace.cake.com/
You can also use the documentation in Swagger, just enter your API key in the Authorize part.