Guía de uso de API de EasyCargo (parte 2)
Como mencionamos en el primer artículo de esta serie, hoy abordaremos la API de EasyCargo desde un enfoque más práctico. Para ello, utilizaremos nuestro cliente API. También probaremos el funcionamiento de la API utilizando la herramienta en línea ReqBin, que permite la comunicación con un servidor web (WWW). Gracias a ello, podemos descargar datos de interés desde nuestra calculadora de carga en contenedores y camiones EasyCargo.
Probar la API es una cosa, pero en la práctica podría estar utilizando un plugin de Java para su software o llamadas en Javascript desde SAP. Otra opción puede ser la plataforma Make, pero esto lo abordaremos en el siguiente artículo de esta serie, junto a otros casos de uso reales de la API.
La imagen anterior muestra nuestro cliente API para EasyCargo. Para enviar cualquier solicitud API al servidor web, el cliente debe estar previamente autorizado. El método para empezar, la primera solicitud es:
POST https://go.easycargo3d.com/api/v1/authentication con el nombre de usuario (username) y la clave API (API key) incluidos en el contenido de la solicitud.
Recibirá un token de autenticación como respuesta del servidor. Cada solicitud API posterior (salvo que se indique lo contrario) debe ser autenticada incluyendo el token obtenido en el encabezado (header) de la solicitud. Es importante destacar que todas las solicitudes API se realizan en base al token del usuario (propietario del token). Las solicitudes y respuestas deben ser creadas en formato JSON o XML.
Ahora que ya hemos sido autenticados, pasemos finalmente a la parte más interesante y entretenida de la API. Supongamos que el usuario X tiene los siguientes cargamentos guardados en su cuenta:
Practicaremos las solicitudes API en las cargas, porque los cargamentos son probablemente la parte más importante de EasyCargo. Otras solicitudes, como la gestión de usuarios, se formulan de manera similar. Además, creemos que cualquier lector de este artículo podrá gestionar la creación de otras solicitudes sin dificultad.
En nuestra documentación de la API de EasyCargo, cada método de la interfaz de programación está descrito y explicado en detalle.
Si aún tiene dudas, por favor póngase en contacto con nosotros a soporte@easycargo3d.com.
Solicitudes API de cargamentos
Según la documentación, con solicitudes bien redactadas podemos:
- Obtener una lista de todos los cargamentos almacenados en el servidor.
- Obtener datos específicos sobre un cargamento concreto desde la cuenta de EasyCargo.
- Incluso podemos crear o eliminar una carga de la cuenta.
Obtener la lista de todos los cargamentos
Obtener información acerca de un cargamento en específico
Crear un cargamento
Como puede observar, la carga fue exitosamente guardada en su cuenta de EasyCargo.
Usted puede abrir fácilmente el cargamento creado mediante la API dentro de su aplicación.
Eliminar un cargamento
El cargamento fue eliminado correctamente de su cuenta de EasyCargo mediante la solicitud correspondiente.
Unos datos más acerca de la API
- El número de solicitudes API está limitado a 60 por hora. Esta limitación funciona con un marco temporal móvil (moving time frame), por lo tanto, la hora exacta en que se alcanza el límite puede variar.
- Los errores de la API se devuelven mediante códigos de estado HTTP comunes. En la mayoría de los casos, el cuerpo de la respuesta contiene un mensaje específico acerca de lo que ha salido mal.
- El cálculo de planificación de carga no puede ejecutarse a través de la API. Su cliente API debe soportar el acceso, la modificación de los encabezados de solicitud y respuesta, así como el análisis (parsing) de datos en formato JSON o XML.
- El usuario de la API tiene que iniciar sesión en la aplicación de EasyCargo para que los cálculos de los planes de carga puedan ser procesados.
- Algunos métodos de la API soportan el uso de parámetros opcionales. Naturalmente conocerá el significado de cada uno de los aspectos de la API con ayuda de la documentación. Puede usar estos parámetros, por ejemplo, al solicitar una lista de todas las cargas.
Solo debe añadirlos a la dirección del recurso después del carácter «?» separados por el carácter «&», con el formato name=value. Por ejemplo: https://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.
En conclusión, la API es un servicio muy útil. Esperamos que esta descripción práctica le haya explicado un poco más acerca de cómo funciona una interfaz de programación.
Este artículo es la segunda entrega de la serie sobre la API de EasyCargo. Si aún no ha visto la primera parte, la puede encontrar aquí. Esta interfaz de programación abre la puerta a un sinfín de posibilidades. En la próxima publicación, descubrirá los beneficios concretos que puede obtener al usar nuestra API y conocerá casos de uso reales.
