Una guía para la API de EasyCargo (parte 3)
El último artículo de nuestra serie API de EasyCargo proporciona una guía completa paso a paso para la planificación de carga utilizando la API. Lo guiaremos a través de todo el proceso, desde la configuración inicial hasta la obtención de informes del plan de carga, demostrando las interacciones API y su correspondiente representación en la interfaz de EasyCargo. Esta guía se basa en conceptos fundamentales al tiempo que presenta funcionalidades avanzadas para optimizar las operaciones de planificación de envíos de carga.
Antes de profundizar en los detalles de la implementación, construya una base sólida con los siguientes dos recursos esenciales. Nuestra guía teórica completa sobre API cubre todos los fundamentos que necesita saber sobre las APIs, mientras que nuestra guía práctica para solicitudes y pruebas de API con ReqBin le guiará en la configuración de un cliente API, así como en las pruebas de endpoints. En conjunto, estos artículos establecen una base esencial y brindan un contexto crucial para los temas tratados en este artículo.
Proceso de planificación de carga paso a paso
Para utilizar las siguientes solicitudes de API, deberá incluir un token de autenticación en el encabezado de su solicitud. Puede encontrar procedimientos de autenticación detallados en nuestro artículo anterior. Para obtener un token de autenticación, debe tener una clave API asociada a su cuenta de usuario. Contacte con nuestro equipo de soporte para solicitar una clave API. Tenga en cuenta que los tokens de autenticación solo son válidos durante 1,5 horas y caducan después por motivos de seguridad.
Configurar el acceso de usuario
El primero y uno de los pasos más cruciales en nuestro proceso de planificación de carga es crear una cuenta, por ejemplo, para el personal del almacén. Usando el endpoint /api/v1/users, puede crear nuevas cuentas de usuario con permisos específicos. Debe proporcionar ciertos detalles del usuario, como se muestra en la solicitud de API a continuación. El panel de EasyCargo refleja inmediatamente esta incorporación, confirmando el acceso del usuario a la cuenta de la empresa. Este proceso simplificado garantiza adecuadamente tanto la gestión de acceso como los controles de seguridad para sus operaciones de planificación de carga mientras mantiene la eficiencia operativa.
En el fragmento de código siguiente, enviaremos una solicitud al endpoint /api/v1/users con un cuerpo que contiene los detalles del usuario para el que deseamos crear una cuenta. Queremos especificar un nombre, apellido, dirección de correo electrónico para iniciar sesión y un rol de usuario. El rol de usuario puede ser administrador (representado por un 1 en el cuerpo de la solicitud) o un usuario normal (representado por un 2).
Vea la plantilla completa de la solicitud de API: https://reqbin.com/duacb1ye
Definición de espacios de carga
Antes de iniciar cualquier operación de planificación de carga, es fundamental definir los espacios de carga. El endpoint /api/v1/cargospaces le permite especificar las dimensiones del contenedor donde se colocarán los elementos. Cada definición de espacio de carga requiere especificaciones importantes que incluyen largo, ancho, alto y capacidad de carga máxima. Actualmente, la API solo admite espacios de carga tipo contenedor para la creación del usuario, con el potencial de admitir otros tipos de espacios de carga en futuras actualizaciones. El sistema valida todas las especificaciones para garantizar que cumplan con los requisitos operativos y los estándares de seguridad. Una vez definido, el espacio de carga aparece en la interfaz de EasyCargo, confirmando una creación exitosa y permitiendo su uso inmediato para la planificación de carga.
En el fragmento de código siguiente, enviaremos una solicitud al endpoint /api/v1/cargospaces con un cuerpo que contiene detalles sobre el contenedor, con el objetivo de crear un nuevo espacio de carga. Especificamos el nombre, ancho, alto, largo y peso máximo de carga. También indicaremos el sistema de medidas utilizado para definir los valores (1 para el sistema métrico y 2 para el sistema imperial) y el tipo de espacio de carga, que se fija en 1, representando un contenedor. Como se mencionó anteriormente, sólo se admite este tipo de espacio de carga.
Vea la plantilla completa de la solicitud de API: https://reqbin.com/8ieqp8ey
Administrar elementos a cargar
Con los espacios de carga definidos, el siguiente paso es crear una nueva carga a través del endpoint /api/v1/shipment-inputs. Este proceso implica especificar tanto los detalles de la carga a enviar como los artículos individuales que se cargarán. Cada artículo requiere atributos integrales que incluyen dimensiones precisas, especificaciones de peso, requisitos de manipulación y restricciones de apilamiento. La interfaz de EasyCargo proporciona una confirmación visual de la creación exitosa de la carga a enviar, mostrando todos los artículos y sus especificaciones. Esta información detallada garantiza una planificación precisa de la carga y una utilización óptima del espacio en los pasos posteriores, manteniendo al mismo tiempo el cumplimiento de las normas de seguridad y los protocolos de manipulación.
En el fragmento de código a continuación, crearemos una nueva carga con 82 piezas de un tipo de artículo usando el endpoint /api/v1/shipment-inputs. En el cuerpo de la solicitud especificaremos el nombre de la carga, sistema de medidas y artículos almacenados. Para los artículos, podemos especificar sus detalles como medidas y restricciones de embalaje. En este ejemplo, mantendremos los productos en un grupo prioritario llamado Berlín, ya que es allí donde queremos entregar los refrigeradores. Permitiremos que sean giratorios y apilables al guardarlos en el espacio de carga. Tenga en cuenta que actualmente no es posible elegir el color o controlar si la etiqueta del artículo se muestra o no a través de la API.
Vea la plantilla completa de la solicitud de API: https://reqbin.com/ozixloob
Proceso de optimización del plan de carga
Una vez que se establecen los detalles de la carga a enviar, el motor de optimización de EasyCargo se encarga de generar planes de carga eficientes. Aunque actualmente la activación del proceso de optimización directamente a través de la API está en desarrollo, los usuarios pueden acceder a esta funcionalidad a través de la interfaz de EasyCargo haciendo clic en el botón Cargar. EasyCargo considera múltiples factores, incluida la distribución del peso, la secuencia de carga y los requisitos de entrega, para crear disposiciones óptimas. Después de la optimización inicial, los usuarios conservan la flexibilidad de realizar ajustes manuales o modificar las selecciones de espacio de carga, asegurando que el plan final cumpla con los requisitos operativos específicos y las limitaciones, a la vez que maximiza la eficiencia.
Generación de informes del plan de carga
Después de finalizar el plan de carga, la documentación completa estará disponible a través del endpoint /api/v1/shipment-reports/{id}. Estos informes detallados del plan de carga abarcan disposiciones de carga, visualizaciones 3D e instrucciones de carga precisas. Cada informe proporciona métricas críticas que incluyen la utilización del espacio, datos de distribución del peso y pautas de manejo específicas para el personal de carga. El sistema genera modelos 3D interactivos e instrucciones en PDF descargables, lo que garantiza la accesibilidad para todas las partes interesadas, como los empleados del almacén y sus clientes. Estos informes sirven como referencias esenciales durante el proceso de carga física, ayudando a mantener la coherencia entre los arreglos de carga planificados y reales. Consulte el informe de carga para obtener todos los detalles.
En el fragmento de código a continuación, recuperaremos todos los detalles del informe de carga utilizando el endpoint /api/v1/shipment-report/{id}. Primero, necesitamos obtener el ID del informe de carga enviando una solicitud GET a /api/v1/shipments. Tome el ID del informe de carga de esta respuesta e inclúyalo en la ruta URL de su próxima solicitud (/api/v1/shipment-report/{id}). La respuesta contendrá todos los detalles que se pueden ver en la imagen de más abajo, en el informe PDF imprimible.
Vea la plantilla completa de la solicitud de API: https://reqbin.com/ust8mrq2
Compartir y colaborar
La fase final implica distribuir la información del plan de carga a las partes interesadas relevantes a través del endpoint /api/v1/shipments. Esta funcionalidad brinda acceso a detalles completos de la carga e informes asociados, incluidas representaciones 3D interactivas del plan de carga. Las partes interesadas pueden acceder al plan a través de una URL pública, lo que permite la visualización y verificación en tiempo real de la disposición de carga. Este enfoque colaborativo garantiza que todos los participantes en el proceso de carga tengan acceso inmediato a la información necesaria, lo que facilita una coordinación eficiente y una implementación precisa del plan de carga. Puede acceder a la URL pública del plan de carga en EasyCargo para ver usted mismo la ubicación de las mercancías.
En el fragmento de código a continuación, recuperaremos todos los detalles de nuestra carga creada previamente utilizando el endpoint /api/v1/shipments/{id}. Para obtener el ID de la carga, primero envíe una solicitud GET a /api/v1/shipments. Una vez que haya identificado su ID de carga, realice una solicitud GET a /api/v1/shipments/{id} para recibir detalles completos de la carga, incluido el enlace público, el enlace del informe de carga y otra información que se muestra a continuación.
Vea la plantilla completa de la solicitud de API: https://reqbin.com/y5p3zysj
En conclusión, no se puede subestimar el impacto de las API en la industria de TI: se han convertido en componentes fundamentales de la arquitectura de software y las operaciones comerciales modernas. La API de EasyCargo ejemplifica cómo las interfaces bien diseñadas pueden agilizar operaciones logísticas complejas manteniendo la precisión y la eficiencia. Esperamos que esta serie completa le haya proporcionado información valiosa sobre cómo aprovechar la API de EasyCargo para sus necesidades logísticas. Ya sea si es nuevo en las API o un desarrollador experimentado, las posibilidades de integración son amplias. Para una consulta personalizada sobre la implementación de EasyCargo en sus operaciones, comuníquese con nosotros a través de nuestro formulario de contacto. Nuestro equipo está listo para ayudarlo a explorar nuestra solución a fin de satisfacer sus requisitos específicos.