Parámetros obligatorios

Se requieren los siguientes parámetros:

• legs – Array de objetos, donde cada objeto representa un tramo de la ruta. Si desea calcular el peaje para diferentes vehículos en cada parte de la ruta, por ejemplo, puede dividirlo en varios legs. (Sólo es necesario para el endpoint independiente)
  • points – Coordenadas que componen el tramo de la ruta. El parámetro points acepta coordenadas como objetos, matrices, codificadas en geohash o codificadas como polyline, como se muestra en los ejemplos siguientes.
    
  • 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
      
  • calculationDate – Fecha y hora en que se tomará la ruta, en formato de timestamp en milisegundos. Ejemplo: 1583492400000
    
  • condition – (Opcional) Objeto que indica qué valores se deben considerar para los peajes donde existen valores condicionales, como un valor descontado para vehículos con tags o un valor específico para feriados. El objeto se compone de:
    • billingType – Indica el tipo de cargo que se debe considerar. Los valores posibles son:[ TAG, NORMAL ];
    • period – Indica el periodo que se debe considerar para devolver el valor exacto del peaje. Los valores posibles son: [ NORMAL, HOLIDAY, LOW_SEASON, HIGH_SEASON ].

Formatos de coordenadas aceptados

Se admiten los siguientes formatos como entrada de coordenadas en el parámetro points:

Objeto – Objetos compuestos por los parámetros latitude y longitude:

"points": [
	{
		"latitude": -19.50489,
		"longitude": -57.43231 
	}
]

Array – Arrays que contienen la latitud y la longitud respectivamente:

"points": [
	[-19.50489,-57.43231],
]

Geohash – Strings con latitud y longitud codificadas en geohash:

"points": [
	"6sx1j15pf",
]

Polyline – String con todas las coordenadas de la ruta codificadas como polyline:

"points": "pp`vB|fp}IlAFhCI"

Ejemplo con parámetros obligatorios

{
    "legs": [
        {
            "points": [
                {
                    "latitude": -23.465395,
                    "longitude": -46.375007
                },
                {
                    "latitude": -23.465957,
                    "longitude": -46.371015
                },
                {
                    "latitude": -23.467154,
                    "longitude": -46.36559
                }
            ],
            "vehicleType": "TRUCK_WITH_TWO_DOUBLE_AXLES"
        }
    ]
}

Parámetros opcionales

• source – Indica en qué base de coordenadas se deben consultar los peajes. Los valores posibles son:
  • MAPLINK – Valor por defecto, si no se informa el parámetro;
  • GMAPS – Debe usarse si la ruta a consultar fue generada por la Routes API de Google.
• billing – Texto que indica el tipo de cobro de la tarifa. Los valores posibles son:
  • DEFAULT – Es el valor por defecto si no se informa el parámetro. Indica que se utilizará el cálculo de cobro de peaje convencional, es decir, solo se devolverán plazas de peaje y pórticos convencionales;
  • FREE_FLOW – Además de las plazas de peaje y los pórticos convencionales, también regresarán los pórticos que forman parte del sistema PaP o Free Flow, actualmente disponible en algunas carreteras.
• transponderOperators – Sólo 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.

Ejemplo con parámetros opcionales

{
    "legs": [
        {
            "points": [
                {
                    "latitude": -23.465395,
                    "longitude": -46.375007
                },
                {
                    "latitude": -23.465957,
                    "longitude": -46.371015
                },
                {
                    "latitude": -23.467154,
                    "longitude": -46.36559
                }
            ],
            "vehicleType": "TRUCK_WITH_TWO_DOUBLE_AXLES",
            "calculationDate": 1710769071000,
            "condition":{
                "billingType":"TAG",
                "period":"HOLIDAY"
            }
        }
    ],
    "billing": "DEFAULT",
    "transponderOperators": [
        "CONECTCAR",
        "SEM_PARAR"
    ],
    "source": "MAPLINK"
}