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é
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.
Pour ce faire, vous devez envoyer une requête sur n'importe quelle plateforme API (p. ex. Insomnia, Postman, Jmeter, etc). La demande doit avoir le format suivant :
- HTTP base URL: https://pumble-api-keys.addons.marketplace.cake.com
- En-tête : { Api-Key : API-KEY-VALUE } – Entrez la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
- Corps : La structure du corps dépend de l’action spécifique que vous souhaitez que l’intégration effectue, mais il doit toujours s’agir d’un corps JSON. Certaines actions ne nécessitent pas de corps.
Voici les formats prédéfinis utilisés pour la requête et le corps du message HTTP :
Envoyer des messages #
POST https://pumble-api-keys.addons.marketplace.cake.com/sendMessage – Envoie un message au canal donné (par son nom) avec le texte fourni.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps:
{
"text" : "text of the message",
"channel" : "general",
"asBot" : true
}ou
Corps:
{
"text" : "text of the message",
"channelId" : "channel id",
"asBot" : true
}Pour envoyer un message à partir de votre compte personnel et non en tant que robot, le paramètre asBot dans le corps de la demande doit être faux.
Envoyer un message direct à un utilisateur #
POST https://pumble-api-keys.addons.marketplace.cake.com/dmUser – Envoie un message à un utilisateur donné (par son email ou son identifiant) avec le texte fourni.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps:
{
"text": "test message from API addon",
"userId" : "64c8b42bfe6f24704d9eeeee"
}ou
Corps:
{
"text": "test message from API addon",
"email": "user.user@email.com"
}Envoyer un message direct à un groupe #
POST https://pumble-api-keys.addons.marketplace.cake.com/dmGroup – Envoie un message à un groupe donné (par son email ou son identifiant utilisateur) avec le texte fourni.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps :
{
"text": "test message from API addon",
"emails" : ["email1@email.com", "email2@email.com"]
}ou
Corps :
{
"text": "test message from API addon",
"userIds" : ["id1", "id2"]
}Répondre à un message #
POST https://pumble-api-keys.addons.marketplace.cake.com/sendReply – Envoie une réponse au message avec l’identifiant donné, dans le canal donné, avec le texte fourni.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps:
{
"channel" : "general",
"messageId" : "65c4ba025f3c124940579c7f",
"text" : "reply to a message"
}ou
Corps :
{
"channelId" : "channel id",
"messageId" : "65c4ba025f3c124940579c7f",
"text" : "reply to a message"
}Ajouter une réaction à un message #
POST https://pumble-api-keys.addons.marketplace.cake.com/addReaction – Ajoute une réaction au message avec l’identifiant donné. La réaction doit être un code sous forme de canal.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps:
{
"messageId": "65c4a8ab99f15a6b2150e0f0",
"reaction": ":grin:"
}Créer un canal #
POST https://pumble-api-keys.addons.marketplace.cake.com/createChannel – Crée un nouveau canal avec le nom et la description donnés.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps:
{
"name" : "channel name",
"type" : "PUBLIC",
"description": ""
}Le Type de canal peut être PUBLIC ou PRIVÉ.
Supprimer le message #
DELETE https://pumble-api-keys.addons.marketplace.cake.com/deleteMessage?messageId=messageId&channel=random – Supprime le message avec l’identifiant donné du canal avec le nom donné.
ou
DELETE https://pumble-api-keys.addons.marketplace.cake.com/deleteMessage?messageId=messageId&channelId=channelId – Supprime le message correspondant à l’identifiant du canal.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Corps : aucun
Lister les messages d’un canal #
GET https://pumble-api-keys.addons.marketplace.cake.com/listMessages?channel=channelName — Liste des messages sur le canal donné. Le curseur et la limite sont optionnels (ils sont utilisés pour la pagination de la même manière que dans le point de terminaison listV1 de l'API).
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Lister tous les canaux et les messages directs #
Corps : aucun
GET https://pumble-api-keys.addons.marketplace.cake.com/listChannels — liste tous les canaux de votre espace de travail.
En-tête : { Api-Key : API-KEY-VALUE } – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.
Lister tous les utilisateurs #
Corps : aucun
GET https://pumble-api-keys.addons.marketplace.cake.com/listUsers — Liste tous les utilisateurs de votre espace de travail.
En-tête : {Api-Key : API-KEY-VALUE} – Entre la clé API que vous avez générée dans l’éditeur de messages et que vous avez reçue en tant que message éphémère.