Integrações

Central de Ajuda Pumble Integrações Pumble API Overview

Pumble API Overview

2 min de leitura
isidora.komaromi@cake.com

Esta funcionalidade está disponível em todos os planos.

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.

Veja como fazer isso:

  1. Clique em + Add apps na barra lateral esquerda
  2. Clique em Instalar 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. Clique em API na barra lateral esquerda
  2. Selecione Add API key
  3. Enter API key name
  4. Clique em Generate para concluir a ação

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:

  • Enviar mensagens
  • Responder uma mensagem
  • Excluir mensagem
  • Adding a reaction to a message
  • Criar canal
  • Listing the messages in a channel (if the channel is private, Addon Bot needs to be a member of that channel)
  • Listar os canais e DMs que pertencem ao usuário que criou a chave

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 Autorizar part.

Delete API key #

You can remove an API key by following these steps:

  1. Clique em API na barra lateral esquerda
  2. Selecione Delete API key
  3. Choose a key from the list
  4. Clique em Excluir para confirmar a ação

Comandos importantes #

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

  • /api-keys generate – o suplemento irá gerar chaves API para um usuário específico e armazená-las em seu banco de dados. Os usuários podem gerar quantas chaves API desejarem.
  • /api-keys list – o suplemento listará todas as chaves API do usuário
  • /api-keys help – para listar todos os comandos válidos que você pode usar

Esse artigo foi útil? #

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