Integrações

Central de Ajuda Pumble Integrações Visão geral da API Pumble

Visão geral da API Pumble

2 min de leitura
isidora.komaromi@cake.com

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

Ao usar o complemento Pumble API, você pode interagir com a documentação da API do Pumble sem usar processos de autenticação complexos. Este complemento permite gerar uma chave de API que possibilita o envio de mensagens, reações e muito mais por meio de simples requisições HTTP.

Instalar complemento da API #

Antes de criar uma chave de API, você precisa instalar o complemento de API no seu espaço de trabalho do Pumble.

Veja como fazer isso:

  1. Clique em + Adicionar aplicativos na barra lateral esquerda
  2. Clique em Instalar na seção API
  3. Permitir permissões 

Gerar uma chave de API #

Após instalar o complemento da API, você poderá gerar chaves de API diretamente no Pumble.

Eis como:

  1. Clique em API na barra lateral esquerda
  2. Selecione Adicionar chave de API
  3. Insira o nome da chave da API
  4. Clique em Gerar para concluir a ação

Você receberá uma mensagem efêmera contendo a chave de API gerada. Esta mensagem não é visível para outros usuários. Copie esta chave para uso futuro. A chave gerada permite a interação com a API pública do Addon, permitindo que os usuários enviem solicitações e executem várias ações no Pumble, incluindo:

  • Enviar mensagens
  • Responder uma mensagem
  • Excluir mensagem
  • Adicionar uma reação a uma mensagem
  • Criar canal
  • Listar as mensagens em um canal (se o canal for privado, o Addon Bot precisa ser membro desse canal).
  • Listar os canais e DMs que pertencem ao usuário que criou a chave

A lista completa de ações disponíveis está na documentação do Swagger. Você também pode usar a documentação do Swagger, basta inserir sua chave de API na seção Authorize.

Excluir chave de API #

Você pode remover uma chave de API seguindo estes passos:

  1. Clique em API na barra lateral esquerda
  2. Selecione Excluir chave de API
  3. Escolha uma tecla da lista
  4. Clique em Excluir para confirmar a ação

Comandos importantes #

Existem algumas ações específicas para interagir com o complemento Pumble API. Você pode usar esses comandos diretamente nas mensagens:

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