Intégration API
Le composant additionnel Pumble API offre une solution transparente aux utilisateurs pour interagir avec l'API de Pumble sans avoir besoin de processus d'authentification complexes. Avec ce composant additionnel, les utilisateurs peuvent générer des clés API sans effort, ce qui leur permet d'envoyer des messages, des réactions et plus encore via de simples requêtes HTTP. Voici comment commencer :
- Cliquez sur le bouton +Ajouter des applis en bas de la barre latérale gauche
- Cliquez sur Installer à côté de l'application AP
Un nouvel onglet s'ouvrira avec le formulaire de consentement et les spécificités de l'intégration.
Il est possible que l'application ait déjà été installée sur votre espace de travail par un autre utilisateur, et vous devrez l'autoriser pour pouvoir l'utiliser. Pour ce faire, cliquez sur le boutonAutoriser du nom de l'application. - 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
Valid commands #
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 delete API-KEYS-VALUE– supprime les clés API de l'utilisateur/api-keys help– pour lister toutes les commandes valides que vous pouvez utiliser/api-keys delete all– delete all API keys at once
Générer des clés API #
Pour générer une clé API, procédez comme suit :
- Type /api-keys generate in the message editor in any channel (you can also add a note next to it)
- Appuyez sur le bouton Entrée/Envoyer pour terminer l'action
Vous recevrez un message éphémère contenant la clé API générée. Ce message n'est pas visible par les autres utilisateurs. Copiez cette clé pour une utilisation ultérieure. La clé générée permet d'interagir avec l'API publique du composant additionnel, ce qui permet aux utilisateurs d'envoyer des demandes et d'exécuter diverses actions au sein de Pumble, notamment :
- 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 peut être utilisée, par exemple, si vous gérez un site de commerce électronique très actif et que vous souhaitez tenir votre équipe de support client informée des nouvelles commandes en temps réel. En intégrant Pumble à l'API, vous pouvez mettre en place un système de notification automatisé qui alerte votre équipe de support client dans les canaux Pumble chaque fois qu'une nouvelle commande est passée.
Interact with the public API of the Addon #
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 (par exemple Insomnia, Postman, Jmeter, etc). La demande doit avoir le format suivant :
- HTTP base URL: https://pumble-api-keys.addons.marketplace.cake.com
- Header: { 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
- Body : 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.
Header: { 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.
Body:
{
“text” : “text of the message”,
“channel” : “general”,
“asBot” : true
}
Pour envoyer un message à partir de votre compte personnel et non en tant que bot, le paramètre asBot dans le corps de la demande doit être faux.
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.
Header: { 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.
Body:
{
“channel” : “general”,
“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 chaîne.
Header: { 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.
Body:
{
“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.
Header: { 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.
Body:
{
“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é.
Header: { 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.
Body: aucun
Lister les messages d'un canal #
GET https://pumble-api-keys.addons.marketplace.cake.com/listMessages?channel=random — liste les 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).
Header: { 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 DMs #
Body: aucun
GET https://pumble-api-keys.addons.marketplace.cake.com/listChannels — liste tous les canaux de votre espace de travail.
Header: { 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.
Body: aucun
List all users #
Body: aucun
GET https://pumble-api-keys.addons.marketplace.cake.com/listUsers — List all users of your workspace.
Header: { Api-Key: API-KEY-VALUE } — enter the API key that you generated in the message editor and received as an ephemeral message