Descripción general
El motor de la API de entregas de OneRail representa los fundamentos para enviar pedidos con la plataforma sin la complejidad adicional del motor completo de la API principal. Además de aceptar pedidos dinámicamente desde la aplicación elegida por su organización, también puede generar solicitudes webhook que pueden proporcionar automáticamente alertas de entregas a las aplicaciones conectadas.
Integrar la operación de su organización mediante la API permite un procesamiento y actualizaciones inmediatas sin la necesidad de intervención o supervisión manual.
Nota:
Por lo general, primero queremos probar nuestra integración de manera que nos permita probar diversas funciones sin afectar las operaciones de producción. Asegúrese de que cualquier proceso que pudiera desencadenar el despacho o el procesamiento de un pedido esté desactivado durante cualquier procedimiento de prueba.
Autenticación
La autenticación de cliente con el motor de la API de OneRail puede clasificarse en dos métodos distintos: basado en usuario y basado en la organización. El proceso de establecer la autenticación entre su aplicación y la API de OR dependerá del método de autenticación deseado. Las siguientes subsecciones describen los pasos para implementar cada uno de los métodos de autenticación disponibles:
Autenticación Basada en Usuario
En este método, las credenciales de usuario individuales configuradas para su cuenta son presentadas a la plataforma por su aplicación cliente. Tras la autenticación exitosa, su aplicación cliente actuará en nombre de las credenciales del usuario que fueron utilizadas para autenticarse.
Para realizar la autenticación con este método, su aplicación cliente tendrá que realizar una solicitud POST al endpoint "user/authenticate". Este endpoint requiere el nombre de usuario deseado y su contraseña.
Para obtener todos los detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Autenticación Basada en Organización
La autenticación basada en la organización utiliza un par de valores (App ID y API Key) que se adjuntan al encabezado de las solicitudes dirigidas al motor de la API de OneRail. El App ID y el API Key se crean para cada remitente de manera individual por nuestro equipo de producto y luego se distribuyen para uso en producción. Cuando se usa este método, cualquier aplicación de su organización que se conecte a la API usará un conjunto de credenciales de autenticación que representa a cada remitente individual.
Para obtener el App ID y el API Key para un remitente, primero debe ponerse en contacto con el equipo de éxito del cliente de OneRail. Ellos proporcionarán una respuesta obtenida de los recursos del producto, que contendrá los valores/credenciales de App ID y API Key generados específicamente para la organización de su remitente. Cada remitente definido en su cuenta necesitará un conjunto de credenciales de API que identifique los pedidos asociados con ese remitente en particular. Asegúrese de que las solicitudes enviadas a la API de entregas por su aplicación estén utilizando las credenciales correctas cuando envíe el pedido de un remitente.
Estas credenciales ahora se pueden usar para autenticar cualquier solicitud destinada a la cuenta de OneRail de su organización. Para implementar estas credenciales, sus valores deben agregarse al encabezado de cualquier solicitud dirigida al motor de la API de OneRail. Los siguientes bloques de código muestran los encabezados y sus valores asociados:
X-ONERAIL-APP-ID: App ID proporcionado por su gerente de implementación X-ONERAIL-API-KEY: API Key proporcionado por su gerente de implementación
Entregas vs Órdenes
Antes de planificar cualquier implementación de la API de entregas, se debe decidir si principalmente se usarán funciones de órdenes o de entregas. Una entrega representa un único pedido de entrega en la plataforma de OneRail, mientras que una orden representa múltiples entregas en la plataforma de OneRail.
Funciones de entrega
Después de la autenticación, su aplicación ahora puede enviar solicitudes funcionales al motor de la API de OneRail en nombre de su organización o usuario (dependiendo del método de autenticación que se utilice). Para esta guía, implementaremos las capacidades de la API de entregas.
Ahora mostraremos cómo usar algunas de las solicitudes/endpoints más esenciales, pero la API de entregas puede realizar una variedad de tareas relacionadas con la interacción con pedidos de entrega.
Creación de una entrega
El endpoint /delivery/create tiene como propósito crear nuevas entregas para la cuenta de OneRail de su organización. Este endpoint acepta solicitudes POST de los clientes con un cuerpo de solicitud (JSON) que contiene la metainformación importante para la entrega.
Para más detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Creación de un pedido
El endpoint /order/create tiene como propósito crear nuevos pedidos para la cuenta de OneRail de su organización. Los pedidos difieren de las entregas en que un solo pedido puede contener múltiples entregas. Este endpoint acepta solicitudes POST de los clientes con un cuerpo de solicitud (JSON) que contiene los detalles para cada entrega individual, así como información que describe el pedido global.
Para obtener todos los detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Actualización Parcial de Pedido
La función de este endpoint proporciona una actualización parcial de los detalles de un pedido específico. Esta funcionalidad también puede agregar o reemplazar artículos y contenedores en un pedido existente (si se necesita esa actualización).
Este endpoint agregará artículos y contenedores a un pedido existente cuando se hagan solicitudes con el método PATCH. Este endpoint reemplazará artículos y contenedores de un pedido existente cuando se hagan solicitudes con el método PUT.
Para obtener más detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Agregar una entrega a un pedido existente
La funcionalidad de este endpoint crea una nueva entrega individual (o múltiples entregas) para un pedido existente.
Para obtener más detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Cancelar un pedido de entrega
Un pedido de entrega enviado a ORD se puede cancelar antes de que se despache el pedido. Esto puede ser designado por su organización o la organización que envía el pedido (dependiendo de su configuración).
Nota: Esta función solo se aplica a cancelaciones de remitentes.
Para cancelar un pedido, se puede enviar una solicitud POST al endpoint "/delivery/{id}/cancel". La "{id}" en la URL debe reemplazarse con el ID de la entrega que se cancela.
Para obtener todos los detalles sobre este endpoint, consulte la siguiente referencia de Swagger:
Obtener Tarifas de Entrega
Antes de enviar una solicitud para crear una entrega en particular, se puede obtener la tarifa para enviar dicha entrega en ese momento sin tener que enviarla ni procesarla. El endpoint "Get Rates" recibirá tarifas de todos los transportistas calificados que apliquen a la entrega.
Para obtener tarifas para una entrega en particular, se envía una solicitud GET al endpoint /delivery/get-rates que contiene metadatos importantes para la entrega. La respuesta del endpoint describirá el costo para enviar la entrega.
Para obtener detalles completos sobre este endpoint, consulte la siguiente referencia de Swagger:
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.