Llamadas a la API de Postman

Introducción

Este artículo se sumergirá profundamente en los fundamentos de los servicios web, equipándote con el conocimiento y ejemplos prácticos necesarios para convertirte en un experto en la realización de llamadas a la API de Postman.

Los servicios web han sido un componente crucial de las aplicaciones modernas por más de dos décadas, evolucionando significativamente desde principios de los años 2000. Estos servicios dependen en gran medida de las APIs (Interfaces de Programación de Aplicaciones) para comunicarse e intercambiar datos. Como desarrolladores y evaluadores, necesitamos herramientas robustas para interactuar eficazmente con estas APIs. Aquí es donde Postman – una popular herramienta de pruebas y desarrollo de APIs entra en juego.

La interfaz web de DataSunrise se basa en llamadas a la API utilizando solicitudes POST basadas en RPC y JSON. Incluso cuando se ejecuta un comando en la Interfaz de Línea de Comandos (CLI), el JSON requerido se crea en función de las opciones del comando, que luego se envía al backend para llamar al RPC requerido. Este proceso también se utiliza en la Consola Web para crear y administrar reglas y otras configuraciones.

¿Qué es Postman?

Postman es una popular herramienta de desarrollo y prueba de APIs que simplifica el proceso de envío de solicitudes, análisis de respuestas y gestión de APIs. Proporciona una interfaz fácil de usar para crear y ejecutar llamadas a la API, facilitando a los desarrolladores el trabajo con servicios web.

Comprendiendo los Servicios Web

Los servicios web son aplicaciones o componentes que se comunican a través de redes utilizando protocolos web estándar. Estos servicios permiten que diferentes sistemas de software interactúen e intercambien datos sin problemas, independientemente de sus tecnologías o plataformas subyacentes.

Características Clave de los Servicios Web

Independencia de Plataforma: Los servicios web pueden ser accesibles desde cualquier dispositivo o sistema operativo con conectividad a internet.
Interoperabilidad: Permiten que distintos sistemas se comuniquen usando protocolos y formatos de datos estandarizados.
Escalabilidad: Los servicios web pueden atender a múltiples clientes y crecer a medida que aumenta la demanda.
Reutilización: Una vez creados, los servicios web pueden ser utilizados por múltiples aplicaciones, promoviendo la reutilización del código y la eficiencia.

¿Qué es RPC?

La llamada a procedimiento remoto (RPC) es un protocolo (JSON-RPC) que permite a un programa ejecutar un procedimiento o función en otra computadora como si se tratara de una llamada a un procedimiento local. RPC es una de las primeras formas de computación distribuida y ha jugado un papel significativo en el desarrollo de los servicios web.

Características Clave de RPC:

Transparencia de Ubicación: El programa que llama no necesita conocer la ubicación física del procedimiento llamado.
Comunicación Sincrónica: Por lo general, RPC sigue un modelo de solicitud-respuesta, en el que el solicitante espera la respuesta antes de continuar.
Orientado a Procedimientos: RPC se enfoca en llamar procedimientos o funciones específicas en sistemas remotos.

Comprendiendo las APIs

Una Interfaz de Programación de Aplicaciones (API) es un conjunto de reglas, protocolos y herramientas que permiten que diferentes aplicaciones de software se comuniquen entre sí. Las APIs definen los métodos y formatos de datos que las aplicaciones pueden utilizar para solicitar e intercambiar información.

Tipos de APIs

SOAP (Protocolo Simple de Acceso a Objetos): Un protocolo que utiliza XML para el intercambio de datos estructurados.
REST (Transferencia de Estado Representacional): Un estilo arquitectónico que utiliza métodos HTTP estándar para la comunicación.
GraphQL: Un lenguaje de consulta para APIs que permite a los clientes solicitar datos específicos que necesitan.

Por Qué las APIs son Importantes

Integración: Las APIs permiten que diferentes sistemas y aplicaciones trabajen juntos de forma fluida.
Flexibilidad: Permiten a los desarrolladores acceder a funcionalidades específicas de otras aplicaciones sin tener que comprender la totalidad de su código.
Eficiencia: Las APIs pueden reducir el tiempo de desarrollo al proporcionar funcionalidades preconstruidas.
Escalabilidad: Las APIs bien diseñadas pueden manejar cargas crecientes y bases de usuarios en expansión.

Realizando Llamadas a la API con Postman

Ahora que entendemos los conceptos básicos de los servicios web y las APIs, exploremos cómo realizar llamadas a la API utilizando Postman. Revisaremos dos ejemplos para demostrar diferentes tipos de llamadas a la API. JSONPlaceholder es un sitio web para probar APIs. Existen más sitios en línea.

Método GET: Una solicitud para recuperar datos específicos de un servidor sin modificar ningún recurso, típicamente usado para obtener información y seguro para solicitudes repetidas.

Método POST: Una solicitud para enviar datos a ser procesados y almacenados por el servidor, a menudo utilizada para crear nuevos recursos o enviar datos de formularios, lo que puede modificar el estado del servidor.

Ejemplo 1: Realizando una Solicitud GET

Comencemos con una solicitud GET sencilla para recuperar datos de una API pública.

Abre Postman y crea una nueva solicitud.
Configura el método HTTP a GET.
Ingresa la siguiente URL: https://jsonplaceholder.typicode.com/posts/1
Haz clic en el botón “Send”.

Deberías recibir una respuesta similar a esta:

{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
  "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
}

Este ejemplo demuestra lo fácil que es recuperar datos de una API utilizando Postman. La respuesta contiene un objeto JSON con información sobre una publicación específica.

Ejemplo 2: Realizando una Solicitud POST

Ahora, vamos a crear un nuevo recurso utilizando una solicitud POST.

1. Crea una nueva solicitud en Postman.

2. Configura el método HTTP a POST.

3. Ingresa la URL: https://jsonplaceholder.typicode.com/posts

4. Ve a la pestaña “Body”, selecciona “raw” y elige “JSON” en el menú desplegable.

5. Ingresa el siguiente JSON en el cuerpo:

{
  "title": "Mi Nueva Publicación",
  "body": "Este es el contenido de mi nueva publicación.",
  "userId": 1
}

Haz clic en el botón “Send”.

Deberías recibir una respuesta similar a esta:

{
  "title": "Mi Nueva Publicación",
  "body": "Este es el contenido de mi nueva publicación.",
  "userId": 1,
  "id": 101
}

Este ejemplo muestra cómo crear un nuevo recurso utilizando una solicitud POST. La API responde con el objeto creado, incluyendo un nuevo id asignado por el servidor.

Si el servidor utiliza HTTPS y tiene un certificado autofirmado, es posible que necesites desactivar la verificación del certificado SSL en la configuración de Postman.

Funciones Avanzadas de Postman para Llamadas a la API

Postman ofrece varias funciones avanzadas que pueden mejorar tu flujo de trabajo en pruebas y desarrollo de APIs:

Variables de Entorno

Postman te permite crear variables de entorno para almacenar y reutilizar valores en múltiples solicitudes. Esto es particularmente útil para gestionar diferentes endpoints de API o tokens de autenticación.

Para usar variables de entorno:

Crea un nuevo entorno en Postman.
Agrega variables como base_url o api_key.
Utiliza estas variables en tus solicitudes con dos llaves dobles, por ejemplo, {{base_url}}/api/endpoint.

Scripts Pre-solicitud

Puedes escribir código JavaScript que se ejecute antes de enviar una solicitud. Esto es útil para generar datos dinámicos o configurar la autenticación.

Ejemplo de script pre-solicitud para generar una marca de tiempo:

pm.environment.set(“timestamp”, new Date().getTime());

Pruebas

Postman te permite escribir pruebas para tus llamadas a la API utilizando JavaScript. Estas pruebas pueden validar los datos de la respuesta, verificar códigos de estado o realizar otras aserciones.

Ejemplo de script de prueba en la sección Tests de una nueva solicitud GET a https://jsonplaceholder.typicode.com/posts/1?timestamp={{timestamp}}:

// Parsear la URL para extraer la marca de tiempo
var url = pm.request.url.toString();
var timestamp = url.split('timestamp=')[1];
// Registrar la marca de tiempo
console.log("Marca de tiempo utilizada:", timestamp);
// Agregar la marca de tiempo a la respuesta para visibilidad
var responseJson = pm.response.json();
responseJson.timestamp = timestamp;
// Establecer la respuesta modificada para visualizarla en Postman
pm.visualizer.set(JSON.stringify(responseJson, null, 2));
// Prueba para asegurar que se envió la marca de tiempo
pm.test("Solicitud enviada con marca de tiempo", function () {
    pm.expect(timestamp).to.not.be.undefined;
});

Revisa la pestaña “Test Results” para comprobar si la prueba fue aprobada. También revisa la pestaña “Console” para ver la marca de tiempo registrada. El cuerpo de la respuesta ahora incluirá el valor de la marca de tiempo.

Mejores Prácticas para Realizar Llamadas a la API con Postman

Organiza tus Solicitudes: Utiliza colecciones y carpetas para agrupar solicitudes relacionadas.
Utiliza Control de Versiones: Postman te permite exportar colecciones. Almacena estas en sistemas de control de versiones como Git.
Documenta tus APIs: Utiliza la función de documentación de Postman para crear documentación de API clara e interactiva.
Automatiza las Pruebas: Utiliza el Collection Runner de Postman y la CLI Newman para automatizar tus pruebas de API.
Maneja la Autenticación Adecuadamente: Utiliza variables de entorno para almacenar información sensible como claves o tokens de API.
Monitorea el Rendimiento de la API: Configura monitores en Postman para hacer seguimiento del rendimiento y tiempo de actividad de la API.

Conclusión

Dominar las llamadas a la API de Postman es una habilidad esencial para los desarrolladores y evaluadores modernos. Al comprender los servicios web, las APIs y RPC, puedes aprovechar las poderosas funciones de Postman para agilizar tus procesos de desarrollo y pruebas de API.

Hemos cubierto los conceptos básicos de cómo realizar llamadas a la API, explorado funciones avanzadas de Postman y discutido las mejores prácticas. Con este conocimiento, estás bien equipado para enfrentar interacciones complejas con APIs y construir aplicaciones robustas e interconectadas.

Recuerda, la clave para volverte experto en las llamadas a la API de Postman es la práctica. Experimenta con diferentes tipos de solicitudes, explora APIs públicas y desafíate a ti mismo a crear suites de pruebas comprensivas para tus propias APIs.

A medida que continúes tu camino en el desarrollo y pruebas de APIs, considera explorar temas más avanzados como la seguridad de las APIs, optimización del rendimiento y pruebas de integración. El mundo de los servicios web es vasto y está en constante evolución, ofreciendo oportunidades infinitas para el aprendizaje y el crecimiento.