Integración API

El complemento API de Pumble ofrece una solución perfecta para que los usuarios interactúen con la API de Pumble sin la necesidad de procesos de autenticación complejos. Con este complemento, los usuarios pueden generar claves API sin esfuerzo, lo que les permite enviar mensajes, reacciones y más a través de simples solicitudes HTTP. A continuación te indicamos cómo empezar:

1. Haz clic en el botón +Añadir aplicaciones en la parte inferior de la barra lateral izquierda
   
   
   
2. Haz clic en el botón Instalar al lado de la aplicación API 
   
   Se abrirá una nueva pestaña con el formulario de consentimiento y los detalles de integración.
   
   Es posible que la aplicación ya haya sido instalada en tu espacio de trabajo por otro usuario y que necesites autorizarla para poder usarla. Para ello, haz clic en el botón Autorizar que se encuentra junto al nombre de la aplicación.
   
   
3. Selecciona el espacio de trabajo en el menú desplegable
   
   Es importante que hayas iniciado sesión en el espacio de trabajo de Pumble que elijas en el menú desplegable.
   
   
4. Haz clic en Permitir para completar la instalación

Comandos válidos #

Hay algunas acciones específicas que se pueden utilizar para interactuar con la integración API en Pumble:

• /api-keys generate – el complemento generará claves API para ese usuario en particular y las almacenará en su base de datos. Los usuarios pueden generar tantas claves API como quieran
• /api-keys list – el complemento enumerará todas las claves API del usuario
• /api-keys help – para enumerar todos los comandos válidos que puedes utilizar

Generar claves API #

Para generar una clave API, haz lo siguiente:

1. Escribe /api-keys generate en el editor de mensajes en cualquier canal (también puedes añadir una nota al lado)
2. Presiona el botón Enter/Enviar/ para completar la acción

Recibirás un mensaje efímero que contiene la clave API generada. Este mensaje no es visible para otros usuarios. Copia esta clave para uso futuro. La clave generada permite la interacción con la API pública del complemento, lo que permite a los usuarios enviar solicitudes y ejecutar diversas acciones dentro de Pumble, que incluyen:

• Envío de mensajes
• Respuesta a un mensaje
• Eliminación de mensajes
• Reacción a un mensaje
• Creación de canales
• Listado de los mensajes en un canal (si el canal es privado, Addon Bot debe ser miembro de ese canal)
• Listado de los canales y mensajes directos que pertenecen al usuario que creó la clave

La lista completa de acciones disponibles se puede acceder en la documentación de Swagger.

La integración API se puede utilizar, por ejemplo, si ejecutas un sitio web de comercio electrónico muy concurrido y quieres mantener informado a tu equipo de atención al cliente sobre nuevos pedidos en tiempo real. Al integrar Pumble con API, puedes configurar un sistema de notificación automatizado que alerta a tu equipo de atención al cliente en los canales de Pumble cada vez que se realiza un nuevo pedido.

Interactuar con la API pública del complemento #

Puedes interactuar con la API pública del complemento para enviar mensajes y realizar otras acciones en Pumble utilizando la clave API generada.

Para hacerlo, debes enviar una solicitud en una plataforma API (por ejemplo, Insomnia, Postman, Jmeter, etc.).

Para el paquete completo de las APIs compatibles, ve la documentación aquí: https://pumble-api-keys.addons.marketplace.cake.com/

También puedes usar la documentación en Swagger, solo introduce tu clave API en la parte Autorizar.