Intégrations

Pumble centre d’aide Intégrations Aperçu de l’API Pumble

Aperçu de l’API Pumble

2 min de lecture
isidora.komaromi@cake.com

Cette fonctionnalité est disponible dans tous les abonnements.

Le module complémentaire API Pumble simplifie l’interaction avec le documentation API de 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.

Installer le module complémentaire API #

Avant de pouvoir créer une clé API, vous devez installer l’extension API sur votre espace de travail Pumble.

Voici comment procéder :

  1. Cliquez sur +Ajouter des applis en bas de la barre latérale gauche
  2. Cliquez sur Installer dans la section API
  3. Acceptez les autorisations 

Générer une clé API #

Une fois votre module complémentaire API installé, vous pouvez générer des clés API directement dans Pumble.

Voici comment procéder :

  1. Cliquez sur API dans la barre latérale gauche
  2. Sélectionnez Ajouter une clé API
  3. Saisissez le nom de la clé API
  4. Cliquez sur Générer 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 module complémentaire, 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é

La liste complète des actions disponibles est disponible dans la documentation Swagger. Vous pouvez également utiliser la documentation dans Swagger, il vous suffit d’entrer votre clé API dans la partie Autoriser.

Supprimer la clé API #

Vous pouvez supprimer une clé API en suivant ces étapes :

  1. Cliquez sur API dans la barre latérale gauche
  2. Sélectionnez Supprimer la clé API
  3. Choisissez une clé dans la liste
  4. Cliquez sur Supprimer pour confirmer l’action

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 module complémentaire 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 module complémentaire va lister toutes les clés API de l’utilisateur.
  • /api-keys help – Pour lister toutes les commandes valides que vous pouvez utiliser.

Cet article vous a-t-il été utile ? #

Thank you! If you’d like a member of our support team to respond to you, please drop us a note at support@pumble.com