Parámetros obligatorios

• calculationMode – Indica el modo de cálculo de la ruta. Admite los siguientes tipos:
  • THE_FASTEST – Considera la ruta más rápida.
  • THE_SHORTEST – Considera la ruta con menor kilometraje.
• destinations – Descripción de los puntos de destino con:
  • siteId – Identificador del local.
  • latitude – Coordenada de latitud en grados decimales.
  • longitude – Coordenada de longitud en grados decimales.
• origins – Descripción de los puntos de origen con:
  • siteId – Identificador del local.
  • latitude – Coordenada de latitud en grados decimales.
  • longitude – Coordenada de longitud en grados decimales.
• tripProfile – Identificador del perfil de la ruta. Recomendamos utilizar siempre el
  "MAPLINK"porque contiene los mapas más actualizados.

Ejemplo con parámetros obligatorios

{
    "calculationMode": "THE_FASTEST",
    "destinations": [
        {
            "latitude": -23.561402303338195, 
            "longitude": -46.63862145421187,
            "siteId": "destination1Liberdade"
        }
    ],
    "origins": [
        {
            "latitude": -23.55363650451996,
            "longitude": -46.620810158377516,
            "siteId": "origin1Mooca"
        }
    ],
    "tripProfile": "MAPLINK"
}

Parámetros opcionales

• avoidanceTypes – Indica que la ruta tendrá que desviarse de ciertos tipos de elementos del sistema de carreteras. Los valores permitidos son: [TUNNELS, BRIDGES, FERRIES, TOLL_ROADS, TOLL_GATES].
• callback – Objeto que contiene los datos del webhook que será utilizado para recibir los eventos del cálculo del problema. De esta forma no será necesario consultar el status del problema para verificar si el mismo fue procesado. La API notificará el webhook cuando la solución estuviera disponible para consulta. Para mas detalles, vea: Como recibir el estado actual del problema via Webhook?
  • url – URL con la dirección que recibirá la devolución de llamada.
  • user – (Opcional) Texto con el nombre del usuario si el endpoint requiere autenticación.
  • password – (Opcional) Texto de la contraseña si el endpoint requiere autenticación.
• restrictionZones – Array con el texto del nombre de la zona de restricción previamente registrada en la Restriction Zone API.

Ejemplo con parámetros opcionales

{
    "avoidanceTypes": [
        "TUNNELS",
        "BRIDGES",
        "FERRIES",
        "TOLL_ROADS",
        "TOLL_GATES"
    ],
    "calculationMode": "THE_FASTEST",
    "destinations": [
        {
            "latitude": -23.682211,
            "longitude": -46.546867,
            "siteId": "SantoAndre"
        }
    ],
    "origins": [
        {
            "latitude": -23.337132,
            "longitude": -46.835427,
            "siteId": "Cajamar"
        }
    ],
    "restrictionZones": [],
    "tripProfile": "MAPLINK"
}