Una guía para la API de EasyCargo (parte 3)
En el más reciente artículo de nuestra serie sobre la API de EasyCargo, presentamos una guía técnica exhaustiva para la planificación de carga automatizada mediante integración API. A lo largo del paso a paso, cubrimos desde la configuración inicial hasta la recuperación de reportes detallados del plan de carga, ilustrando cada interacción con la API y su reflejo en la interfaz gráfica de EasyCargo. Este recurso combina fundamentos esenciales con funcionalidades avanzadas, orientadas a maximizar la eficiencia operativa y aportar valor añadido a sus procesos logísticos.
Antes de adentrarse en los aspectos técnicos de la implementación, es fundamental establecer una base sólida con dos recursos clave. Por un lado, nuestra guía teórica completa sobre API aborda todos los conceptos esenciales que necesita dominar para comprender el funcionamiento y el propósito de las interfaces de programación. Por otro lado, nuestra guía práctica sobre el uso de ReqBin le muestra cómo configurar un cliente API y realizar pruebas efectivas de endpoints. Juntos, estos materiales proporcionan el contexto necesario y una comprensión estructurada para aprovechar al máximo las funcionalidades descritas en este artículo.
Planificación de carga mediante API: guía paso a paso
Para ejecutar correctamente las solicitudes descritas a continuación, es necesario incluir un token de autenticación en el encabezado de cada petición. Los detalles completos sobre el proceso de autenticación se encuentran en un artículo anterior de esta serie. Deberá disponer de una clave API vinculada a su cuenta de usuario para obtener un token de autenticación. Si aún no la tiene, puede solicitarla contactando al equipo de soporte de EasyCargo. Por razones de seguridad, recuerde que los tokens de autenticación tienen una validez de 1,5 horas y expiran automáticamente tras ese periodo.
Gestión de accesos: configuración inicial de usuarios
Uno de los pasos iniciales —y más relevantes— del proceso de planificación de carga es la creación de cuentas de usuario, por ejemplo, para operarios del almacén o personal de logística. Utilizando el endpoint /api/v1/users, es posible generar nuevos perfiles con permisos definidos según el rol requerido. Para ello, será necesario proporcionar ciertos datos básicos, como nombre, apellido, dirección de correo electrónico y el tipo de rol asignado.
Una vez enviada la solicitud, la nueva cuenta se registra de forma inmediata en el panel de EasyCargo, habilitando el acceso correspondiente dentro de la estructura organizacional de la empresa. Este enfoque estructurado optimiza la administración de permisos y fortalece los controles de seguridad, sin sacrificar la eficiencia operativa.
Aquí puede verse una muestra de código en el que se envía una solicitud al endpoint /api/v1/users. El cuerpo de la solicitud contiene los datos requeridos para la creación del usuario: nombre, apellido, correo electrónico y rol. El rol puede definirse como administrador (valor 1) o usuario estándar (valor 2), según el nivel de acceso deseado.
Puede acceder a la plantilla completa de la solicitud de API en: https://reqbin.com/duacb1ye
Espacios de carga, definición y configuración
Resulta imprescindible definir con precisión los espacios de carga disponibles antes de iniciar cualquier operación de planificación. Para especificar las dimensiones exactas del contenedor en el cual se dispondrán los artículos a transportar se debe recurrir al endpoint /api/v1/cargospaces. Requiriendo esta definición de parámetros clave, tales como largo, ancho, alto y capacidad de carga máxima de cada espacio de carga. En estos momentos, la API soporta espacios de carga tipo contenedor para la creación del usuario, aunque está previsto incorporar soporte para otros tipos de espacios en próximas actualizaciones.
El sistema realiza una validación exhaustiva de las especificaciones proporcionadas para asegurar el cumplimiento de los estándares operativos y normativas de seguridad vigentes. Una vez definido, el espacio de carga queda reflejado de manera inmediata en la interfaz de EasyCargo, confirmando su correcta creación y habilitando su utilización en los procesos de planificación de carga.
En el siguiente ejemplo se presenta una solicitud al endpoint /api/v1/cargospaces, con un cuerpo que detalla las características del contenedor según el espacio de carga que se creará. En la petición se especifican el nombre, ancho, alto, largo y peso máximo de carga permitido. Asimismo, se indica el sistema de unidades empleado (valor 1 para sistema métrico y 2 para sistema imperial) y el tipo de espacio de carga, fijado en 1 para representar un contenedor, que es el único tipo admitido por el momento.
Acceda a la plantilla completa de la solicitud de API: https://reqbin.com/8ieqp8ey
Gestión de los elementos a cargar
Una vez establecidos los espacios de carga, debemos continuar con la creación de una nueva carga mediante el endpoint /api/v1/shipment-inputs. Por tanto, se requiere detallar tanto las características generales de la carga a transportar como las especificaciones individuales de cada artículo a cargar. Cada ítem debe contar con atributos completos, incluyendo dimensiones exactas, peso, condiciones especiales de manipulación y limitaciones para el apilamiento. Para confirmar que la creación de la carga ha sido exitosa, la interfaz de EasyCargo ofrece una confirmación visual inmediata que la valida, mostrando todos los artículos con sus respectivas especificaciones. Esta información detallada es fundamental para asegurar una planificación precisa y una utilización eficiente del espacio en las etapas posteriores, al mismo tiempo que se cumple con los estándares de seguridad y los protocolos de manejo.
En el ejemplo de código que sigue, se procederá a crear una nueva carga compuesta por 82 unidades de un tipo específico de artículo, utilizando el endpoint /api/v1/shipment-inputs. En el cuerpo de la solicitud se incluirá el nombre asignado a la carga, el sistema de unidades y la descripción de los artículos almacenados. Para estos últimos, se podrán definir sus medidas y restricciones de embalaje. En este caso particular, los productos se agrupan bajo la etiqueta de grupo prioritario “Berlín”, que corresponde al destino final de entrega de los refrigeradores. Además, se habilita que los artículos sean girados y apilados dentro del espacio de carga. Es importante mencionar que, por el momento, la API no permite seleccionar el color de los artículos ni controlar la visibilidad de sus etiquetas.
Acceda a la plantilla completa de la solicitud de API: https://reqbin.com/ozixloob
Plan de carga: su proceso de optimización
En cuanto se hayan definido los detalles de la carga a transportar, el motor de optimización de EasyCargo se ocupa de elaborar planes de carga altamente eficientes. Si bien la activación directa de este proceso de optimización mediante la API se encuentra actualmente en fase de desarrollo, los usuarios pueden acceder a esta funcionalidad a través de la interfaz de EasyCargo, simplemente presionando el botón de Cargar. El sistema de EasyCargo toma en cuenta diversos factores, como la distribución del peso, la secuencia de carga y los requerimientos específicos de entrega, para generar configuraciones optimizadas. Posterior a la optimización automática, los usuarios mantienen la capacidad de efectuar ajustes manuales o modificar la selección del espacio de carga, garantizando que el plan final se adapte a las necesidades operativas particulares y restricciones de carga existentes, al mismo tiempo que maximiza la utilización eficiente del espacio.
Generación y acceso a informes del plan de carga
Una vez que el plan de carga ha sido finalizado, la documentación completa se encuentra disponible mediante el endpoint /api/v1/shipment-reports/{id}. Estos reportes detallados del plan de carga incluyen las disposiciones de carga, representaciones visuales en 3D y precisas instrucciones para el proceso de carga. Cada informe ofrece métricas esenciales, tales como la utilización del espacio, la distribución del peso y las directrices específicas para el personal encargado de la manipulación de la carga.
Por tanto, el sistema proporciona modelos 3D interactivos y reportes en formato PDF con instrucciones que pueden descargarse o imprimirse, facilitando el acceso a la información para todos los actores involucrados, desde empleados de almacén hasta clientes finales. Estos informes funcionan como una referencia clave durante la ejecución física de la carga, asegurando la coherencia entre la planificación y la implementación real.
Para obtener todos los detalles, acceda al reporte de carga.
Para obtener el informe completo, primero debe recuperarse el ID correspondiente enviando una solicitud GET al endpoint /api/v1/shipments. Utilice el ID del informe de carga para realizar una solicitud al endpoint /api/v1/shipment-report/{id}, esto le permitirá acceder a todos los detalles del informe, tal como se muestra en la imagen del reporte PDF imprimible que se encuentra más abajo.
Acceda a la plantilla completa de la solicitud de API: https://reqbin.com/ust8mrq2
Compartir y colaborar en el plan de carga
La etapa final del proceso consiste en distribuir la información del plan de carga a todas las partes interesadas a través del endpoint /api/v1/shipments. Esta funcionalidad permite el acceso completo a los detalles de la carga y a los informes asociados, que incluyen representaciones interactivas en 3D del plan de carga. Las partes involucradas pueden visualizar y verificar la disposición de la carga en tiempo real mediante una URL pública, facilitando así una comunicación transparente y fluida.
Este método colaborativo asegura que todos los actores del proceso cuenten con acceso inmediato a la información crítica, promoviendo una coordinación efectiva y una ejecución precisa del plan de carga. La URL pública del plan de carga está disponible en EasyCargo para que pueda consultarse en cualquier momento y revisar la ubicación exacta de los artículos a transportar.
Para obtener estos datos, primero debe recuperar el ID de la carga enviando una solicitud GET al endpoint /api/v1/shipments. Luego de haber identificado el ID, se realiza una solicitud GET al endpoint /api/v1/shipments/{id}, lo que permite acceder a toda la información detallada de la carga, incluyendo el enlace público, el informe de carga y otros datos relevantes, tal como se detalla a continuación.
Acceda a la plantilla completa de la solicitud de API: https://reqbin.com/y5p3zysj
El papel de las API en el ecosistema tecnológico actual es indiscutible: se han consolidado como pilares esenciales tanto en la arquitectura de software como en los procesos operativos de las empresas modernas. La API de EasyCargo es un claro ejemplo de cómo una interfaz bien estructurada puede simplificar la logística más compleja sin sacrificar precisión ni eficiencia.
Confiamos en que esta serie le haya brindado una comprensión sólida sobre cómo aprovechar al máximo la integración de EasyCargo en sus flujos logísticos. Ya sea que esté dando sus primeros pasos en el mundo de las API o cuente con experiencia como desarrollador, las oportunidades de integración y automatización son amplias y adaptables.
Si desea explorar cómo implementar EasyCargo en su entorno operativo, no dude en contactarse a través del formulario de contacto. El equipo está disponible para ofrecerle asesoramiento personalizado y acompañarlo en la adopción de una solución a medida que responda a sus necesidades específicas.