Intégrations

Pumble centre d’aide Intégrations Pumble API Overview

Pumble API Overview

2 min de lecture
isidora.komaromi@cake.com

Cette fonctionnalité est disponible dans tous les abonnements.

By using the Pumble API addon, you can interact with Pumble’s API documentation without using any complex authentication processes. This addon lets you generate an API key that allows you to send messages, reactions, and more via simple HTTP requests.

Install API addon #

Before you can create an API key, you need to install the API addon on your Pumble workspace.

Voici comment procéder :

  1. Click on + Add apps in the left sidebar
  2. Click on Install in the API section
  3. Allow permissions 

Generate an API key #

Once your API addon is installed, you can generate API keys directly in Pumble.

Here’s how:

  1. Click on API in the left sidebar
  2. Select Add API key
  3. Enter API key name
  4. Click Generate to complete the action

You’ll receive an ephemeral message containing the generated API key. This message is not visible to other users. Copy this key for future use. The generated key enables interaction with the Addon’s public API, allowing users to send requests and execute various actions within Pumble, including:

  • Envoyer des messages
  • Laisser une réponse à un message
  • Supprimer un message
  • Adding a reaction to a message
  • Créer un canal
  • Listing the messages in a channel (if the channel is private, Addon Bot needs to be a member of that channel)
  • Lister des canaux et DMs appartenant à l'utilisateur qui a créé la clé

The full list of available actions is available in the Swagger documentation. You can also use the documentation in Swagger, just enter your API key in the Authorize part.

Delete API key #

You can remove an API key by following these steps:

  1. Click on API in the left sidebar
  2. Select Delete API key
  3. Choose a key from the list
  4. Click Delete to confirm the action

Commandes valides #

There are a few specific actions for interacting with the Pumble API addon. You can use these commands directly in messages:

  • /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.

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