Explorar el marco de desarrollo de Bolt

Objetivos de aprendizaje

Después de completar esta unidad, podrá:

Explicar qué es Bolt.
Explicar las API más comunes que utilizan las aplicaciones de Slack.
Identificar los ámbitos que permiten que las aplicaciones de Slack lean y escriban mensajes.

Antes de comenzar

En este módulo, le mostramos los pasos para crear una aplicación de Slack simple con el marco de desarrollo de Bolt para JavaScript. Completar estos pasos es opcional y no hay retos prácticos. Sin embargo, si desea seguir el proceso y realizar los pasos, necesitará lo siguiente.

Un espacio de trabajo de Slack personal. Puede configurar un espacio de trabajo de Slack personal si aún no lo hizo. Consulte las políticas de su compañía si desea utilizar un espacio de trabajo o activos proporcionados por un empleador.
Glitch, ngrok u otro entorno de hospedaje para desarrollar y probar las aplicaciones de Slack. Este módulo utiliza Glitch. Si no tiene una cuenta de Glitch, puede crear una cuenta gratis.

Conocer Bolt

Bolt es un marco de desarrollo que facilita la creación de aplicaciones de Slack con las funciones de plataforma más recientes de Slack. Utiliza una interfaz de escucha que activa patrones comunes cuando se manejan las solicitudes que provienen de Slack, independientemente del tipo.

Bolt también tiene varios valores predeterminados integrados, como compatibilidad con OAuth, verificación de eventos y una interfaz simplificada para funciones como los pasos de flujos de trabajo de aplicaciones. Este módulo proporciona una descripción general de las API de Slack, los patrones de escucha de Bolt y la creación de una aplicación Bolt para JavaScript.

Un vistazo de las API de Slack

Antes de crear con Bolt, es importante tener un alto nivel de entendimiento de las interfaces de programación de aplicaciones (API). Si no está familiarizado con las API, consulte el módulo Fundamentos de las API.

Las aplicaciones de Slack tienen acceso a un rango de API que proporcionan acceso para leer, escribir y actualizar datos en Slack. Las dos API para aplicaciones más utilizadas son la API web y la API de eventos. Funcionan como el ping-pong. Slack utiliza la API de eventos para enviar un evento a la aplicación. La aplicación utiliza la API web para enviar una interacción de vuelta.

API de eventos

La API de eventos utiliza suscripciones a eventos para enviar cargas JSON a la aplicación a través de HTTP. Cuando la aplicación recibe un evento, reconoce la carga y decide qué acción realizar. Los eventos pueden ser cualquier acción que suceda dentro de un espacio de trabajo: un mensaje que se publicó en un canal, un usuario que abre la ficha de inicio de la aplicación o un nuevo usuario que se une al espacio de trabajo. La lista completa de eventos con cargas de muestra se encuentra en el sitio de la API de Slack.

Bolt incluye auxiliares integrados para recibir y redirigir eventos a los agentes de escucha de la aplicación, y para exponer información útil, como el espacio de trabajo y los usuarios o canales relevantes. Más adelante en este módulo, hablaremos sobre los agentes de escucha.

API web

La API web es una recopilación de métodos HTTP con convenciones de llamada similares para interactuar con los objetos en Slack, como canales, pláticas, eventos y mucho más. Estas interacciones incluyen el envío de mensajes interactivos y enriquecidos a un canal u otra superficie, o la consulta de información del espacio de trabajo, como una lista de usuarios. La lista completa de métodos de API web se encuentra en el sitio de la API. Bolt incluye un cliente integrado con funciones, como el manejo de límites de velocidad y la lógica de reintento para simplificar la llamada y la respuesta de las solicitudes de API web.

Y para los casos de uso de nichos, como administrar un espacio de trabajo o realizar auditorías de seguridad, hay API adicionales disponibles en la documentación.

¿Está listo para utilizar Bolt con la aplicación? ¡Vamos a ello!

Crear una aplicación de Slack

Para empezar, debe crear una nueva aplicación de Slack. Puede crear una aplicación desde cero o utilizar una plantilla de manifiesto. Para este módulo, utilizará un manifiesto que ya está configurado con los permisos y eventos. Puede modificar la aplicación más tarde si lo desea.

Cree una nueva aplicación de Slack con nuestra plantilla de manifiesto. El vínculo abre un menú desplegable para seleccionar el espacio de trabajo de desarrollo donde crea y prueba la aplicación.
Seleccione su espacio de trabajo y, a continuación, haga clic en Siguiente. En este ejemplo, se seleccionó el espacio de trabajo de SeaMoss.
Después de seleccionar el espacio de trabajo, verá otra ventana emergente: Revisar resumen y crear aplicación. Esta ventana incluye información sobre los permisos y eventos que contendrá la aplicación. Hablaremos de esto más detenidamente más adelante. Continúe y haga clic en Create (Crear).
Será redirigido automáticamente a la página Información básica de la aplicación, que se denomina Aplicación de ejemplo. Haga clic en Got It (De acuerdo) en el mensaje de bienvenida.

La página Información básica contiene una descripción general de la aplicación, además de las credenciales importantes que necesita para utilizar las API web y de eventos, como el secreto de firma en el encabezado Credenciales de la aplicación.

No dude en echar un vistazo, agregar una descripción y un icono de la aplicación; luego, empezaremos a explorar otras opciones de configuración.

Solicitar ámbitos e instalar la aplicación

Los ámbitos otorgan a la aplicación permiso para hacer llamadas de API web en el espacio de trabajo instalado (publicar un mensaje, por ejemplo). Si desea seleccionar los ámbitos que agregará a la aplicación, desplácese hasta la página OAuth y permisos en la barra lateral.

En la página de la aplicación, seleccione OAuth & Permissions (OAuth y permisos) en la barra lateral.
Desplácese hasta Ámbitos. Aquí puede ver los ámbitos de token y bot channels:history y chat:writer, que se incluyeron en la creación de la aplicación a partir del manifiesto. Estos ámbitos otorgan a la aplicación el permiso para leer y publicar mensajes en los canales públicos a los que pertenece. Para escuchar mensajes en los canales privados y mensajes directos (DM) a los que pertenece la aplicación, necesitará suscribirse a ámbitos *:history adicionales correspondientes al tipo de canal.
Vuelva a la parte superior de la página OAuth y permisos, y haga clic en Install to Workspace (Instalar en espacio de trabajo).
A continuación, haga clic en Allow (Permitir).

Después de la instalación, volverá a la página OAuth y permisos, donde podrá ver un nuevo token de acceso de OAuth de usuario de bot.

Los tokens de acceso están llenos de poder. Representan los permisos otorgados a la aplicación por el usuario instalador (en este caso, usted).

Recuerde mantener en secreto su token de acceso. Como mínimo, debe evitar revisar el token de acceso en un control de versiones público, y acceder a través de una variable de entorno. La documentación de API también contiene una lista de las prácticas recomendadas para la seguridad de aplicaciones.

Agregar la aplicación al canal

Para poder hospedar, desarrollar y probar la aplicación, tema que trataremos en la próxima unidad, debe agregar la aplicación a un canal público. En este ejemplo, la aplicación de muestra de SeaMoss se agregó al canal #general.

Abra el espacio de trabajo de Slack.
Haga clic con el botón derecho en el canal en el espacio de trabajo personal.
Haga clic en Open channel details (Abrir la información del canal).
Luego, haga clic en la ficha Integrations (Integraciones).
Haga clic en Add an App (Agregar una aplicación).
Si no ve su aplicación al instante, búsquela en el campo de búsqueda. Luego, haga clic en Add (Agregar) junto a la aplicación.

Al regresar al canal #general, podrá ver que se agregó la aplicación. Ahora está listo para hospedar y desarrollar la aplicación.

Mensaje de canal que indica que FS3 se unió a #general junto a sample_app