Aprende a probar tu API en POSTMAN y configurarlas en las peticiones HTTP de Atom

En este artículo, veremos en simples pasos un caso de uso donde una API se conecta con ATOM y las configuraciones para este caso de uso, utilizando POSTMAN y el componente de Petición HTTP en Atom. ¡Comencemos!

Caso de uso:

Una empresa utiliza un sistema interno que registra a sus clientes mediante un campo llamado ID o identificador. Este ID es único para cada cliente y permite realizar solicitudes específicas de información. Para esto el cliente deberá loguearse con su usuario y clave que será proporcionada por correo electrónico. Contando con este ID, y a través del componente "Petición HTTP" de Atom, se conectarán ambos sistemas para solicitar los datos adicionales necesarios del cliente, como por ejemplo, cuando éste desea saber su saldo pendiente o la fecha de su próxima factura. 

Cuando el cliente interactúa con un bot y solicita esta información, luego del logueo correspondiente por parte del cliente, Atom envía una consulta al sistema interno usando el componente Petición HTTP utilizando este campo ID. Estos datos son devueltos por el sistema interno a Atom y, estos campos son almacenados en el apartado de Guardar Respuesta del componente HTTP de la plataforma. De esta forma, la información solicitada queda automáticamente disponible y actualizada para que, si la conversación escala a un agente, este pueda ver los detalles completos del cliente sin necesidad de hacer una nueva solicitud.

Es importante destacar que, para que esta integración funcione correctamente, primero es necesario comprobar que la autenticación a la API del sistema interno esté configurada y funcionando adecuadamente. Para ello, se utiliza POSTMAN, donde se puede validar el acceso y probar las peticiones a la API. Una vez verificado que la autenticación es exitosa, se configura la misma autenticación en el componente "Petición HTTP" de Atom, permitiendo que el flujo de información sea continuo y sin interrupciones.

Prueba de conexión con Postman

Previamente a configurar la petición HTTP, podemos realizar una prueba para verificar si la autenticación con nuestra API es correcta. 

Para esto realizaremos en Postman una prueba de Basic Authentication.Para esto necesitas contar con el nombre de usuario y contraseña de acceso de la API. 

Basic <Base64 encoded username and password>

Si deseas saber más sobre distintos tipos de autenticación en POSTMAN, lee el siguiente artículo

Para hacer la prueba de autenticación, entonces nos dirigimos a POSTMAN

Allí en New Request, utilizaremos el Método GET, escribiremos la URL de nuestra API, y en la sección Authorization, seleccionamos en este caso Basic Auth y colocamos el acceso con usuario y contraseña correspondiente. Hacemos clic en Send para probar:

Una vez que la conexión fue exitosa visualizarás el código 200 OK, como se muestra en pantalla, lo que significa que la conexión fue exitosa, y en la pestaña BODY, busca la sección de Authorization y el token que se generó que se encuentra entre comillas luego de los dos puntos de la misma línea. Eso te servirá más adelante para configurar los encabezados de nuestro componente petición HTTP, donde Authorization será nuestra Key y en este caso Basic cG9zdG1hbjpwYXNzd29yZA== será nuestro token para el encabezado de esta conexión.

Configuración en Petición HTTP

Llenamos los campos correspondientes en la petición HTTP como veremos a continuación. Dentro de nuestro bot accedemos al componente Petición HTTP, haciendo doble click para acceder a los campos en la barra lateral derecha de nuestra pantalla.

Aquí realizaremos las siguientes configuraciones:

1. Utilizaremos el método POST y colocaremos la URL de la API a la cual nos conectaremos

En el cuerpo detallaremos los campos que enviaremos a la API con el ID de nuestro cliente:

Cómo encabezados, utilizaremos un Key y Token correspondientes, el cual se describió en el paso anterior.

Luego en Guardar respuesta por ejemplo dado que nuestro cliente queria saber el saldo pendiente, guardaremos en los campos de información SALDOPENDIENTE y FECHA_PAGO_SALDO, la información que proviene de la API de las variables data.adeudo y data.fecha_limite