Integração de API

O API de suplemento do Pumble oferece uma solução perfeita para os usuários interagirem com a API do Pumble sem a necessidade de processos de autenticação complexos. Com este complemento, os usuários podem gerar chaves de API sem esforço, permitindo-lhes enviar mensagens, reações e muito mais por meio de simples solicitações HTTP. Veja como começar:

1. Clique no botão +Adicionar aplicativos na parte inferior da barra lateral esquerda
   
   
   
2. Clique no botão Instalar ao lado do aplicativo API 
   
   Uma nova guia será aberta com o formulário de consentimento e detalhes de integração.
   
   É possível que o aplicativo já tenha sido instalado. em seu espaço de trabalho por outro usuário, e você precisará autorizá-lo para poder usá-lo. Para fazer isso, clique no botão Autorizar ao lado do nome do aplicativo.
   
   
3. Selecione o espaço de trabalho no menu suspenso
   
   É importante que você esteja logado no espaço de trabalho do Pumble que você escolheu no menu suspenso.
   
   
4. Depois de criar enquetes, você pode gerenciá-las com alguns comandos simples:

Comandos importantes #

Existem algumas ações específicas que podem ser usadas para interagir com a integração API no Pumble:

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

Generate API keys #

Para gerar uma chave de API, faça o seguinte:

1. Digite /api-keys generate no editor de mensagens em qualquer canal (você também pode adicionar uma nota ao lado)
2. Pressione o botão Enter/Enviar 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 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 pode ser visualizada na documentação do Swagger.

A integração API pode ser usada, por exemplo, se você administra um site de comércio eletrônico movimentado e deseja manter sua equipe de suporte ao cliente informada sobre novos pedidos em tempo real. Ao integrar o Pumble com API, você pode configurar um sistema de notificação automatizado que alerta sua equipe de suporte ao cliente nos canais do Pumble sempre que um novo pedido é feito.

Interaja com a API pública do Addon #

Você pode interagir com a API pública do suplemento para enviar mensagens e realizar outras ações no Pumble usando a chave API gerada.

Para isso, você precisa enviar uma solicitação por meio de uma plataforma de API (por exemplo, Insomnia, Postman, JMeter).

Para obter a lista completa de APIs compatíveis, consulte a documentação aqui. https://pumble-api-keys.addons.marketplace.cake.com/

Você também pode usar a documentação no Swagger, basta inserir sua chave de API na parte Authorize.