Introducción API
Mediante esta introducción se pretende mostrar las dos formas en las que Colaborador puede trabajar con la documentación para conectarse al API:
-
Utilizar el software Postman:
Permite realizar las llamadas del API contra el entorno {baseurl}. Estas llamadas preconfiguradas ya están preparadas para trabajar con los parámetros que requiere Colaborador, por lo tanto, pueden utilizarse para ver resultados en tiempo real, cambiar parámetros, ver las respuestas JSON formateadas, entre otros. Para trabajar con Postman, se deben seguir los siguientes pasos:- Acceder a la documentación del API de Demo adaptada a Postman.
- Hacer clic en el botón situado en la parte superior derecha "Run in Postman". Si no se tiene Postman instalado, la página llevará a la descarga adecuada según el sistema operativo. Si ya se tenía instalado Postman, se importará la colección de llamadas completa.
- Descargar las variables de entorno para Postman desde el siguiente enlace: Colaborador Postman Environment.
- Importar el JSON descargado a las variables de entorno de Postman. Más información sobre variables de entorno en el siguiente enlace: Manage Postman Environments.
-
Algunos productos del API de Demo están compuestos por sesiones, por lo que, para vender dichos productos, se deben usar las llamadas del API generadas para ese propósito. La documentación y las llamadas de ejemplo se pueden encontrar en la URL de la documentación de sesiones.
Para usar Postman con sesiones, se seguirán los mismos pasos explicados anteriormente y se utilizará el mismo archivo de variables de entorno ya descargado.
Utilizar la documentación con llamadas y respuestas de ejemplo:
Es accesible desde el panel. Simplemente se debe navegar por el menú izquierdo o comenzar desde la sección principal de la documentación.