Importación Contenido

Encuentra toda la informacion que necesitas para poder integrarte en función a tus necesidades con nuestro software.
  • Recuperación Contenido
  • Recuperación por SFTP
  • Recuperación API
1. Recuperación de contenido de la plataforma

De tal forma que se usa OptimManage para la integración de puntos de entrega y de productos para su uso y evaluación, también se puede usar la plataforma para, una vez cargadas y evaluadas dichas opciones, descargar los ficheros con las optimizaciones realizadas para su uso en la propia plataforma del cliente.

Esta opción se puede dividir en tres tipos de recuperación; recuperación de rutas evaluadas y/o calculadas por API, recuperación de rutas evaluadas y/o calculadas por JSON y recuperación de los albaranes firmados por JSON.

1.1. Recuperación de firmas, cajas y observaciones

Este tipo de recuperación de datos de la plataforma se basa en los puntos de entrega que conforman la ruta una vez avaluada y optimizada. Una vez se tenga el usuario o usuarios de perfil técnico, y el token de acceso para la conexión a la API, ya se podrá recuperar la ruta evaluada. Los parámetros de la conexión son los siguientes:

URL: https://restapi.optimroute.com/api/integration/route/history

MÉTODO: POST

CONTENIDO: application/json

Junto a estos parámetros, también se añade un nuevo campo de tipo fecha para mantener un registro de cuando se ha realizado esta recuperación de los datos. A continuación se especifica para dicho campo su definición y sus restricciones. Los campos marcados con el símbolo indicarán la obligatoriedad del mismo. Por el contrario, los campos que no lleven dicho símbolo serán tratados como información opcional. En caso de tener dependencia entre campos, se indicará en cada una de las especificaciones; así como los campos a los que se debe esa dependencia (obligatoriedad).

1. Fecha de la recuperación [dateDeliveryStart] (✱):

• Identificador: dateDeliveryStart

• Descripción: Indica la fecha en la que se lleva a cabo la recuperación.

• Restricciones: Fecha (datetime). Formato: YYYY-MM-DD

Ejemplos:

• 2020-01-12

• 2020-01-25

• 2020-02-01

Parámetro de recuperación de firmas, cajas y observaciones
{
      “dateDeliveryStart”: “2020-04-18”
}

Una vez enviada la petición, tan solo se tendrá que esperar la respuesta de nuestro servidor. En ésta, encontraremos los campos que seguidamente se definen.

• routes
• vehicleId
• routeId
• deliveryZoneId
• deliveryPoints
• id
• order
• estimatedArrivalTime
• requiredSignature
• driverArrivalTime
• signature
• signatureTime
• dniDeliveryNote
• nameDeliveryNote
• deliveredBoxes
• devolutionDeliveryNote

La especificación de los campos es la siguiente:

1. Identificador del vehículo [vehicleId]:

• Identificador: vehicleId

• Descripción: Identificador del vehículo que ha realizado la ruta en nuestra plataforma.

2. Identificador de la ruta [routeId]:

• Identificador: routeId

• Descripción: Identificador de la ruta a recuperar.

3. Identificador de la zona de reparto [deliveryZoneId]:

• Identificador: deliveryZoneId

• Descripción: Zona de reparto a la que pertenece el punto de entrega (cliente). Una zona de reparto agrupa un conjunto de puntos de entrega. Un mismo vehículo no puede realizar entregas en zonas de reparto diferentes, pero sí pueden realizar entregas en una misma zona de reparto diferentes.

4. Identificador del punto de entrega [deliveryPoints.id]:

• Identificador: deliveryPoints.id

• Descripción: Identifica el punto de entrega. No pueden existir dos puntos de entrega con el mismo identificador.

5. Identificador del punto de entrega ya evaluado y/o calculado [deliveryPoints.order]:

• Identificador: deliveryPoints.order

• Descripción: Identifica el punto de entrega en la nueva posición una vez evaluada y/o calculada la ruta. No pueden existir dos puntos de entrega con el mismo identificador.

6. Hora estimada de llegada calculada del chófer [deliveryPoints.estimatedArrivalTime]:

• Identificador: deliveryPoints.estimatedArrivalTime

• Descripción: Especifica la hora del día, calculada por nuestra plataforma, en la que llegará el chófer al punto de entrega.

7. Firma requerida [deliveryPoints.requieredSignature]:

• Identificador: deliveryPoints.requiredSignature

• Descripción: Identifica el punto de entrega en la nueva posición una vez evaluada y/o calculada la ruta. No pueden existir dos puntos de entrega con el mismo identificador.

8. Hora de llegada calculada del chófer [deliveryPoints.driverArrivalTime]:

• Identificador: deliveryPoints.driverArrivalTime

• Descripción: Especifica la hora del día en la que el chófer ha llegado al punto de entrega.

9. Imagen de la firma del cliente [deliveryPoints.signature]:

• Identificador: deliveryPoints.signature

• Descripción: Imagen (en base64) de la firma del albarán del cliente a la hora de la entrega de los productos en su establecimiento.

10.Hora de la firma del cliente [deliveryPoints.signatureTime]:

• Identificador: deliveryPoints.signatureTime

• Descripción: Fecha y hora en la que el cliente firmo la entrega del pedido.

11. Documento de identificación del cliente [deliveryPoints.dniDeliveryNote]:

• Identificador: deliveryPoints.dniDeliveryNote

• Descripción: Documento de identificación personal del cliente al que se le entrega el pedido.

12.Nombre y apellido/s del cliente [deliveryPoints.nameDeliveryNote]:

• Identificador: deliveryPoints.nameDeliveryNote

• Descripción: Nombre y apellidos del cliente al que se le entrega el pedido.

13.Número de cajas entregadas [deliveredBoxes]:

• Identificador: deliveredBoxes

• Descripción: Número total de cajas que el chófer deposita en el punto de entrega. En caso de no tener ningún valor, aparecerá como null.

14.Notas de la entrega [devolutionDeliveryNote]:

• Identificador: devolutionDeliveryNote

• Descripción: Notas opcionales del cliente respecto a la entrega de los productos en el caso que haya alguna devolución. En caso de no tener ningún valor, aparecerá como null.

En cuanto al fichero JSON descargado el formato será el siguiente: 

Ejemplo JSON – Recuperación de firmas, cajas y observaciones
{
     "routes": [
         {
             "vehicleId": 2,
             “routeId”: 1,
             "deliveryZoneId": "BCN",
             "deliveryPoints": [
             {
                 "id": "X032",
                 "order": 1,
                 "estimatedArrivalTime": 27000
                 "requiredSignature": false,
                 "driverArrivalTime": “2020-01-28 15:42:29",
                 "signature": “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/ 2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwS ExIQEw8QEBD2wBDAQMDAwQDBAgEBAgQCwkLEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB AQEBAQEBAQEBAQEBAQEBAQEBDwAARCADmAPoDASIAAhEBAxEB8QAHQABAAIDAQEBAQAAAAAAAAAAAA YHAwQFAgEICfAD0QAAIBAwMDAgMFBAcJAAAAAAABAgMEBQYREgchMRNBFFFhFSJxgZEIFzJSFiQzU2KCoTQ 1QkNykrGy0f/EABQBAQAAAAAAAAAAAAAAAAAAAAD/ /9k=",
                 "signatureTime": "2019-11-07 15:42:50”,
                 "dniDeliveryNote": "12345678P",
                 "nameDeliveryNote": “Cliente de prueba",
                 "deliveredBoxes": 3,
                 “devolutionDeliveryNote": null
             }
             ]
         }
     ]
 }
1.2. Recuperación de rutas evaluadas o calculadas por JSON o CSV

Esta opción le permite realizar la descarga de las rutas evaluadas y optimizadas desde la sección panel de control una vez se haya evaluado o calculado la ruta. Así, aparecerá un botón de descarga en la parte superior derecha al darle clic al botón de descarga aparecerá un cuadro de dialogo que le permitirá elegir las rutas que desea obtener y el formato deseado entre JSON y CSV.

Como se puede observar en la imagen siguiente, se debe indicar si la extracción de datos de la plataforma se hace de una ruta evaluada o de una ruta calculada.

El fichero resultante de esta operación será un JSON o un CSV con los siguientes campos:

• routes
• vehicleId
• deliveryZoneId
• deliveryPoints
• id
• order
• estimatedArrivalTime

En el caso del fichero CSV se sustituye el campo deliveryPoint y el campo deliveryPoint.id por un campo que fusiona estos dos llamado deliveryPointId que hace la misma función (como se puede ver en el ejemplo CSV de debajo). Como estos campos se extraen de la propia plataforma OptimManage, no tendrán restricciones ya que tendrán ya una salida correcta.

1. Identificador del vehículo [vehicleId]:

• Identificador: vehicleId

• Descripción: Identificador del vehículo que ha realizado la ruta en nuestra plataforma.

2. Identificador de la zona de reparto [deliveryZoneId]:

• Identificador: deliveryZoneId

• Descripción: Zona de reparto a la que pertenece el punto de entrega (cliente). Una zona de reparto agrupa un conjunto de puntos de entrega. Un mismo vehículo no puede realizar entregas en zonas de reparto diferentes, pero sí pueden realizar entregas en una misma zona de reparto diferentes vehículos.

3. Identificador del punto de entrega [deliveryPoints.id]:

• Identificador: deliveryPoints.id

• Descripción: Identifica el punto de entrega. No pueden existir dos puntos de entrega con el mismo identificador.

4. Identificador del punto de entrega ya evaluado y/o calculado [deliveryPoints.order]:

• Identificador: deliveryPoints.order

• Descripción: Identifica el punto de entrega en la nueva posición una vez evaluada y/o calculada la ruta. No pueden existir dos puntos de entrega con el mismo identificador.

5. Hora de llegada calculada del chófer [deliveryPoints.estimatedArrivalTime]:

• Identificador: deliveryPoints.estimatedArrivalTime

• Descripción: Especifica la hora del día, calculada por nuestra plataforma, en la que llegará el chófer al punto de entrega.

En cuanto al fichero CSV descargado el formato será el mismo que el usado a la hora de subir un archivo CSV de puntos de entrega normal con los campos especificados en este apartado. El formato CSV contendrá una cabecera y los valores de los campos separados por el carácter , (una coma).

Cabecera CSV – Recuperación de rutas evaluadas y/o calculadas
deliveryPointId,deliveryZoneId,vehicleId,order,estimatedArrivalTime 
Ejemplo CSV – Recuperación de rutas evaluadas y/o calculadas
deliveryPointId,deliveryZoneId,vehicleId,order,estimatedArrivalTime “1”,”BCN”,”12”,1,27000 

En cuanto al fichero JSON descargado el formato será el mismo que el usado a la hora de subir un archivo JSON de puntos de entrega normal con los campos especificados en este apartado.

Cabecera CSV – Recuperación de rutas evaluadas y/o calculadas
{
     "routes": [
         {
             "vehicleId": 12,
             "deliveryZoneId": "BCN",
             "deliveryPoints": [
             {
                 "id": "X032",
                 "order": 1,
                 "estimatedArrivalTime": 27000
             },
             {
                 "id": "PD213",
                 "order": 2,
                 "estimatedArrivalTime": 32400
             }
             ]
         }
     ]
 }
 

Esta opción le permite realizar la descarga de los datos obtenidos por los chóferes de todos los puntos de entrega que ha visitado desde la sección de Panel de control. En esta sección, veremos todo el histórico de rutas y de los puntos de entrega que pertenecen a cada una de ellas. Para descargar el fichero JSON hay un botón en la parte superior derecha de la página web. También se puede descargar el fichero de un único punto de entrega desde el botón de descarga que tienen cada uno de los clientes.

El fichero resultante de esta operación será un JSON con los siguientes campos:

• id

• signature

• deliveredBoxes

• devolutionDeliveryNote

La especificación de los campos es la siguiente:

1. Identificador del punto de entrega [id]:

• Identificador: id

• Descripción: Identifica el punto de entrega. No pueden existir dos puntos de entrega con el mismo identificador.

2. Imagen de la firma del cliente [signature]:

• Identificador: signature

• Descripción: Imagen (en base64) de la firma del albarán del cliente a la hora de la entrega de los productos en su establecimiento.

3. Número de cajas entregadas [deliveredBoxes]:

• Identificador: deliveredBoxes

• Descripción: Número total de cajas que el chófer deposita en el punto de entrega. En caso de no tener ningún valor, aparecerá como null.

4. Notas de la entrega [devolutionDeliveryNote]:

• Identificador: devolutionDeliveryNote

• Descripción: Notas opcionales del cliente respecto a la entrega de los productos en el caso que haya alguna devolución. En caso de no tener ningún valor, aparecerá como null.

Recuperación de contenido de la plataforma por SFTP

Las credenciales necesarias para la recuperación de contenido mediante SFTP son las siguientes:

USUARIO: Usuario creado por nuestros técnicos.

CONTRASEÑA: Contraseña del usuario creada por nuestros técnicos.

SERVIDOR: Dirección a la que conectarse con el usuario asignado.

PUERTO: Puerto por el cual se conectará el cliente a nuestro servidor.

Nuestro técnico se encargara de crear toda la estructura de directorios personalizada que se explica a continuación. Vistos los tipos de directorios en el apartado de Importación mediante SFTP (8), nos centraremos en los de recogida de ficheros, que son lo siguientes:

Directorio de históricos (routes/) (Recogida de ficheros): En esta carpeta el cliente recogerá los ficheros JSON descargados desde nuestra plataforma con el histórico de las rutas. Se podrán descargar, o una ruta en concreto como por ejemplo: route_MAD-1_20200304.json, donde MAD-1 es el identificador de la ruta, o el archivo general con todas las rutas, como por ejemplo routes_20200304.json.

Directorio de optimizaciones (optimizations/) (Recogida de ficheros): En esta carpeta el cliente recogerá los ficheros JSON descargados desde nuestra plataforma con las optimizaciones de las rutas. El fichero se llamará: optimization_20200227.json.

Directorio de evaluaciones (evaluations/) (Recogida de ficheros): En esta carpeta el cliente recogerá los ficheros JSON descargados desde nuestra plataforma con las evaluaciones de las rutas. El fichero se llamará: evaluation_20200227.json.

Directorio de albaranes (deliveryNotes/) (Recogida de ficheros): En esta carpeta el cliente recogerá los ficheros JSON descargados desde nuestra plataforma con las firmas de los albaranes de los sus clientes en PDF. El fichero se llamará: deliveryNote_2_1_20200301.json, donde el 2 es el id de la empresa, el 1 es el id del punto de entrega y los siguientes números son al fecha.

Recuperación de contenido de la plataforma por API

De tal forma que se usa OptimManage para la integración de puntos de entrega y de productos para su uso y evaluación, también se puede usar la plataforma para, una vez cargadas y evaluadas dichas opciones, descargar los ficheros con las optimizaciones realizadas para su uso en la propia plataforma del cliente.

Esta opción se puede dividir en tres tipos de recuperación; recuperación de rutas evaluadas y/o calculadas por API.

Lo único que necesitaremos para la recuperación de contenido vía API es enviar una petición con la fecha.

URL: https://restapi.optimroute.com/api/integration/route/history

MÉTODO: POST

CONTENIDO: application/json

1. Fecha de la recuperación [dateDeliveryStart] (✱):

• Identificador: dateDeliveryStart

• Descripción: Indica la fecha en la que se lleva a cabo la recuperación.

• Restricciones: Fecha (datetime). Formato: YYYY-MM-DD

Ejemplos:

• 2020-01-12

• 2020-01-25

• 2020-02-01

Ejemplo JSON – Recuperación de firmas, cajas y observaciones
{
      “dateDeliveryStart”: “2020-04-18”
}
https://www.optimmanage.com/wp-content/uploads/2020/05/stitelogo-1.png
Optimmanage nace del sector logístico, tras 20 años de experiencia decidimos poner fin a la gran mayoría de los problemas que vivimos, desarrollando una solución funcional multiplataforma apta para todo tipo de negocio.

CONTÁCTANOS

Horario Comercial de Lunes – Viernes

de 10 – 14 y de 16 – 19

+34 930 08 52 41

© 2019 Copyright – All Rights Reserved. Project by booleanwork.com

ContáctanosBienvenidos a OptimManage

Horario de atención
Lunes a Viernes de 09:00 a 18:00

Teléfono
+34 930085241