Parámetros obligatorios

• points – Array de objetos, donde cada objeto representa una parada en la ruta con los siguientes campos:
  • siteId – Identificador del local.
  • latitude – Coordenada de latitud en grados decimales.
  • longitude – Coordenada de longitud en grados decimales.

Ejemplo:

{
"points": [
        {
            "siteId": "Point 1-Extrema",
            "latitude": -22.859246,
            "longitude": -46.339289
        },
        {
            "siteId": "Point 2-Betim",
            "latitude": -19.985117,
            "longitude": -44.202667
        }
    ]
}

Parámetros opcionales

• calculationMode – Indica el modo de cálculo para el enrutamiento. Admite los siguientes tipos:
  • THE_FASTEST – Considéralo la forma más rápida. Valor por defecto.
  • THE_SHORTEST – Considere la ruta con menor kilometraje.
• avoidanceTypes – Indica que la ruta tendrá que desviarse de ciertos tipos de elementos del sistema de carreteras. Los valores permitidos son:
  • TUNNELS – La ruta evitará los túneles;
  • BRIDGES – La ruta evitará los puentes;
  • FERRIES – La ruta evitará los transbordadores.
• toll – Indica que la ruta debe informar del cálculo del peaje. Deben introducirse los siguientes parámetros:
  • transponderOperators – (Opcional) Solo para rutas en Brasil. Array que indica qué códigos de integración deben devolverse. Los valores posibles son:
    • CONECTCAR – Se devolverá el código de servicio de Conectcar;
    • SEM_PARAR – Se devolverán los códigos de servicio Sem Parar: Vía Fácil y Sem Parar Pay;
  • vehicleType – Texto que define el tipo de vehículo que se tendrá en cuenta para calcular el peaje. Los valores posibles son:
    • MOTORCYCLE
    • CAR
    • CAR_WITH_THREE_SIMPLE_AXLES
    • CAR_WITH_FOUR_SIMPLE_AXLES
    • BUS_WITH_TWO_DOUBLE_AXLES
    • BUS_WITH_THREE_DOUBLE_AXLES
    • BUS_WITH_FOUR_DOUBLE_AXLES
    • BUS_WITH_FIVE_DOUBLE_AXLES
    • TRUCK_WITH_NINE_DOUBLE_AXLES
    • TRUCK_WITH_TWO_SINGLE_AXIS
    • TRUCK_WITH_TWO_DOUBLE_AXLES
    • TRUCK_WITH_THREE_DOUBLE_AXLES
    • TRUCK_WITH_FOUR_DOUBLE_AXLES
    • TRUCK_WITH_FIVE_DOUBLE_AXLES
    • TRUCK_WITH_SIX_DOUBLE_AXLES
    • TRUCK_WITH_SEVEN_DOUBLE_AXLES
    • TRUCK_WITH_EIGHT_DOUBLE_AXLES
    • TRUCK_WITH_TEN_DOUBLE_AXLES
• crossedBorders – Solo para rutas en Brasil. Indica que también debe devolverse alguna información sobre la ruta:
  • level – Devolverá las ciudades o estados que atraviesa la ruta. Valores posibles:
    • CITY – Devuelve a las ciudades atravesadas por la ruta.
    • STATE – Devuelve los estados atravesados por la ruta.
    • NONE – El parámetro no se utilizará.
  • reverseGeocode – La Reverse Geocode API se utilizará para devolver más información sobre puntos importantes de la ruta. Valores posibles:
    • START_END – Se devolverán los campos startAddress y endAddress con información sobre el primer y el último punto de la ruta.
    • START_END_LEGS – El campo firstPointAddress se devolverá dentro de cada leg (tramo de la ruta), con información sobre el punto de partida del legen cuestión.
• callback – Sólo disponible en Trip Asincrónica. Contiene los datos de callback, que es una URL de webhook para recibir los eventos de cálculo de problemas. Los posibles argumentos son:
  • url – URL con la dirección que recibirá lo callback.
  • user – Texto con el nombre del usuario si el webhook requiere autenticación.
  • password – Texto con la contraseña en caso de que el endpoint necesite autenticación.
• restrictionZones – Array con el texto del nombre de la zona de restricción registrada previamente en la Restriction Zone API
• place – Se utiliza para devolver puntos de interés (POI) en la ruta. Deben introducirse los siguientes parámetros:
  • bufferRouteInMeters – Entero con el radio de búsqueda de puntos de interés a lo largo de la ruta. Límite de 500 metros.
  • bufferStoppingPointsInMeters – Entero con el radio de búsqueda de puntos de interés en las paradas. Límite de 500 metros.
  • onlyMyPlaces – Valor booleano que indica si sólo se devolverán los establecimientos de su propia base o si también se utilizará la base nativa del servicio. Para más información, consulte la documentación de la API POIs.
  • categories – Array con las categorías de los establecimientos deseados.
  • subCategories – (Opcional) Array con las subcategorías de los establecimientos deseados.

A continuación se muestra un ejemplo con todos los parámetros opcionales:

{
     "calculationMode": "THE_FASTEST",
     "points": [
        {
            "siteId": "Point 1-Extrema",
            "latitude": -22.859246,
            "longitude": -46.339289
        },
        {
            "siteId": "Point 2-Betim",
            "latitude": -19.985117,
            "longitude": -44.202667
        }
    ],
    "avoidanceTypes":["FERRIES"],    
    "toll": {
        "vehicleType": "CAR",
        "transponderOperators": ["CONECTCAR","SEM_PARAR"]
    },
    "place": {
        "categories": [
            "ALIMENTOS_E_BEBIDAS",
            "ACADEMIAS"
        ],
        "bufferRouteInMeters": 500,
        "bufferStoppingPointsInMeters": 500,
        "onlyMyPlaces": true,
    },
    "crossedBorders": {
        "level": "CITY",
        "reverseGeocode": "START_END_LEGS"
    },
    "restrictionZones": [
        "MG_BR381_530_km_AltCentl_5_75",
        "MG_BR381_620_km_AltCentl_5_61"
    ],
 }