Uso de Postman con yield analytics API

Información general

El objetivo de este tutorial es realizar una nueva instalación de Postman y salir con una plantilla para cada llamada API disponible en la API pública de Yield Analytics. Esto demostrará que las llamadas API se pueden adaptar a datos de clientes específicos sin necesidad de compilar repetidamente el parámetro reutilizable de una llamada API. Al final del tutorial, debe tener una base sólida para interactuar con la API a través de:

• Una plantilla para cada llamada api en la API pública de Yield Analytics
• Variables de entorno que permiten abstraer llamadas de plantilla para satisfacer las necesidades de los clientes
• Un entorno de trabajo para un cliente específico
• Cómo exportar y compartir una llamada específica en la que está trabajando
• Conocimientos básicos de la conversión de llamadas HTTP a otros formatos, como cURL

Plantillas de Swagger para los servicios de LA API de Yield Analytics

• Plantilla de servicio de producto e inventario
• Plantilla de servicio de pedido de inserción
• Plantilla de servicio de línea de pedido
• Plantilla de servicio del motor de consultas

Importación de una plantilla de Swagger en Postman

• Copie la dirección URL de la plantilla de Swagger copiando la dirección o haciendo clic en ella y copiando la dirección URL de la plantilla deseada enumerada anteriormente.

• En Postman, seleccione: archivo → importar.

  

• Seleccione Importar desde vínculo y pegue la dirección URL de la plantilla.

  

• Tenga en cuenta que los encabezados tienen una clave estándar y un valor encapsulado en {{}}. Déjelos en su lugar y continúe con la sección siguiente.

  

Configuración de un entorno de Postman con variables

• En Postman, el texto encapsulado en {{}} se tratará como una variable. Las variables son símbolos que pueden tomar valores diferentes. Es posible que esté familiarizado con las variables de otros lenguajes de su experiencia de programación anterior. Las variables de Postman funcionan de la misma manera.

• Postman también admite el concepto de un entorno. Se trata básicamente de una colección de variables que se traducen en un grupo de trabajo para el cliente deseado con el que desea interactuar.

• En la imagen siguiente se muestran varias variables: {{client_url}}, {{accepts}}, {{username}}, {{password}} y {{source}}

  

• Para configurar un entorno, haga clic en el icono de engranaje situado encima de la llamada API activa actual y seleccione Administrar entornos.

  

• A continuación, haga clic en el botón Agregar, asigne un nombre al entorno y agregue los nombres de variable con valores como se muestra en la imagen siguiente.

  

• Por último, seleccione el nuevo entorno en la lista desplegable de entornos.

  

• Cuando se invoca la llamada API, las variables de {{}} se reemplazarán por el valor que haya asignado a la variable en tiempo de ejecución.

Nota:

Las plantillas están diseñadas para acelerar el desarrollo de llamadas API y es muy probable que no funcionen hasta que los parámetros url y body se hayan ajustado con los datos aplicables al cliente.

Exportación de una llamada API desde Postman

• Postman proporciona varios mecanismos para compartir el trabajo. La exportación proporciona una manera rápida y sencilla de compartir una llamada API en la que está trabajando. El proceso descargará un archivo .json que incluye todos los parámetros que ha agregado a la llamada. A continuación, otro usuario puede importar este archivo .json mediante el proceso de importación descrito anteriormente. La única diferencia es que importaría desde un archivo en lugar de un vínculo.

  Nota:

  Tendrá que borrar la contraseña antes de exportarla.

• Los principales objetivos aquí son el uso compartido de conocimientos y proporcionar ingeniería con un ejemplo que se puede ejecutar que se puede usar para determinar rápidamente si la llamada es incorrecta o si la acción del servidor es incorrecta.

  

Conversión de una llamada https a un comando cURL

Postman proporciona una manera rápida y sencilla de convertir estas llamadas API HTTPS en otros formatos. Simplemente haga clic en el vínculo "Código" en el lado derecho de la llamada API activa y, a continuación, seleccione la conversión que desee como se muestra en la siguiente imagen: