Integrações

Integração de API

isidora.komaromi@cake.com

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. Click on Install button next to the API app 

    A new tab will open with the consent form and integration specifics.

    It’s possible that the app has already been installed on your workspace by another user, and you will need to authorize it so that you can use it. To do it, click on the Authorize button next to the app name.

  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. Clique em Autorizar para concluir a instalação

Comandos válidos #

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 delete API-KEYS-VALUE – remove as chaves API do usuário
  • /api-keys help – para listar todos os comandos válidos que você pode usar

Gere chaves API #

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

  1. Digite /api-keys generate no editor de mensagens em qualquer canal
  2. Pressione o botão Enter/Enviar para concluir a ação

Você receberá uma mensagem efêmera contendo a chave 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 suplemento, permitindo aos usuários enviar solicitações e executar diversas ações dentro do 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 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 suplemento #

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 fazer isso, você precisa enviar uma solicitação em qualquer plataforma API (por exemplo Insomnia, Postman, Jmeter, etc). A solicitação deverá ter o seguinte formato:

  • URL base HTTP: https://pumble-api-keys.addons.marketplace.cake.com
  • Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera
  • Corpo: A estrutura do corpo depende da ação específica que você pretende que a integração execute, mas sempre precisa ser um corpo JSON. Algumas ações não requerem um corpo.

Aqui estão os formatos predefinidos usados para a solicitação HTTP e o corpo:

Envie mensagens #

POST https://pumble-api-keys.addons.marketplace.cake.com/sendMessage — Envie uma mensagem para o canal determinado (pelo nome) com texto sendo o texto fornecido.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo:

{

  “text” : “text of the message”,

  “channel” : “general”,

  “asBot” : true

}

Para enviar uma mensagem da sua conta pessoal e não como bot, o parâmetro asBot no corpo da solicitação deve ser false.

Responda uma mensagem #

POST https://pumble-api-keys.addons.marketplace.cake.com/sendReply — Envie uma resposta à mensagem com a identificação fornecida, no canal determinado, sendo texto o texto fornecido.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo:

{

    “channel” : “general”,

    “messageId” : “65c4ba025f3c124940579c7f”,

    “text” : “reply to a message”

}

Adicione reação a uma mensagem #

POST https://pumble-api-keys.addons.marketplace.cake.com/addReaction — Adicione uma reação à mensagem com a identificação fornecida. A reação deve ser um código string.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo:

{

    “messageId”: “65c4a8ab99f15a6b2150e0f0”,

    “reaction”: “:grin:”

}

Criar um canal #

POST https://pumble-api-keys.addons.marketplace.cake.com/createChannel — Crie um novo canal com o nome e a descrição fornecidas.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo:

{

    “name” : “channel name”,

    “type” : “PUBLIC”,

    “description”: “”

}

O Tipo do canal pode ser PÚBLICO ou PRIVADO.

Apagar mensagem #

EXCLUIR https://pumble-api-keys.addons.marketplace.cake.com/deleteMessage?messageId={messageID}&channel=random — Exclua a mensagem com a identidade fornecida do canal com o nome fornecido.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo: nenhum

Liste mensagens em um canal #

OBTENHA https://pumble-api-keys.addons.marketplace.cake.com/listMessages?channel=random — Lista mensagens em um determinado canal. Cursor e limite são opcionais (eles são usados para paginação da mesma forma que no endpoint listV1 na API).

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo: nenhum

Liste todos os canais e DMs #

OBTENHA https://pumble-api-keys.addons.marketplace.cake.com/listChannels — Liste todos os canais do seu espaço de trabalho.

Cabeçalho: {Api-Key: API-KEY-VALUE } – insira a chave de API que você gerou no editor de mensagens e recebeu como uma mensagem efêmera

Corpo: nenhum

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