Guía de uso de API de EasyCargo (parte 2)
Como fue mencionado en la primera parte del artículo, hoy nos “acercaremos” a la API de EasyCargo más por la parte práctica. Para esta ocasión, utilizaremos nuestro cliente API. También probaremos la operación de la API usando la herramienta online ReqBin. El cual permite la comunicación con un servidor WWW, desde donde podemos descargar datos de interés de nuestra calculadora de carga en los contenedores y camiones EasyCargo. Probar el API es una cosa, pero en la vida real, es posible que esté utilizando un plugin de Java para tu software o Javascript para hacer llamadas desde SAP. Otra opción puede ser la Plataforma Make, pero esto junto a otros casos de uso de API en casos reales lo abordaremos en el siguiente artículo de esta serie.
Vea el resultado de la solicitud mencionada en la herramienta ReqBin
La imagen de la parte superior muestra a nuestro cliente para utilizar nuestra API de EasyCargo. Para poder mandar alguna petición a la API a nuestro servidor web, el cliente debe primero ser autorizado. Para empezar, la primera petición es un método POST http://go.easycargo3d.com/api/v1/authentication con el username y la API key en el contenido. Recibirás un token de autenticación como respuesta del servidor. Cada petición subsecuente (a menos que se indique lo contrario) de la API debe ser autenticada agregando el token obtenido como header. Vale la pena resaltar aquí que todas las peticiones de la API son hechas en base al token del usuario. Las peticiones y las respuestas deben ser creadas en formato JSON o XML.
Ahora que ya nos hemos autenticado, vamos a la parte más divertida de la API. Asumimos que X usuario tiene los siguientes cargamentos almacenados en su cuenta.
Practicaremos con las peticiones a la API en las cargas, porque los cargamentos son probablemente la parte más importante de EasyCargo. Otras peticiones tales como el manejo de usuarios están formulados de una manera muy similar, ya que creemos que cada uno de los lectores de este artículo será capaz de manejar otras peticiones. En nuestra documentación de la API, cada método de la interfaz de programación está descrito y explicado.
Si aún hay dudas, favor de ponerse en contacto con nosotros a soporte@easycargo3d.com o use nuestro formulario de contacto.
Peticiones a la API de cargamentos
Como la documentación de la API nos informa, con peticiones apropiadamente redactadas somos capaces de obtener la lista de todos los cargamentos desde el servidor, también información y cargas específicas de la cuenta de EasyCargo. Se puede incluso crear o borrar una carga desde la cuenta.
Obtener la lista de todos los cargamentos
Vea el resultado de la solicitud mencionada en la herramienta ReqBin
Obtener información acerca de un cargamento en específico
Vea el resultado de la solicitud mencionada en la herramienta ReqBin
Crear un cargamento
Vea el resultado de la solicitud mencionada en la herramienta ReqBin
Como pueden ver, la carga fue exitosamente guardada en su cuenta de EasyCargo.
Ustedes pueden simplemente abrir el cargamento creado con el método de la API en su aplicación.
Borrar un cargamento
Vea el resultado de la solicitud mencionada en la herramienta ReqBin
El cargamento fue correctamente removido de su cuenta de EasyCargo con la petición apropiada.
Unos datos más acerca de la API
- El número de las peticiones de la API está limitada en tiempo (60 peticiones por hora). Las cuotas se verifican por un marco de tiempo móvil, por tanto en un periodo de tiempo determinado solo es permitido un número específico de peticiones.
- Los errores son regresados por un código de estado HTTP común. En la mayoría de los casos, el cuerpo de la respuesta contiene un mensaje específico acerca de lo que salió mal.
- La calculadora de cargamentos no puede ser ejecutada a través de la API.
- Su cliente para la API tiene que soportar el acceso y la modificación de la petición y el encabezado de la respuesta y diseccionar 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. Ustedes naturalmente aprenderán el significado de cada uno de los aspectos de la API con ayuda de la documentación. Pueden usar estos parámetros, por ejemplo, cuando se elabora una petición para obtener la lista de todos las cargas. Solo se agregan a la dirección de recurso después del signo “?”, separado por el carácter “&” en la forma name=value, por ejemplo: http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.
Llegamos a la conclusión en este artículo que la API es un servicio muy útil. Esperamos que esta descripción práctica les haya explicado un poco más acerca de la programación de interfaces y cómo funciona. El artículo de hoy es el segundo en una serie sobre la API de EasyCargo, si aún no han visto la primera parte, la pueden encontrar aquí. La programación de interfaces abre una infinidad de posibilidades. En la siguiente publicación, encontrarán qué beneficios pueden tener usando la API y aprendan acerca de sus usos en la vida real.
