Parâmetros obrigatórios

Os seguintes parâmetros são necessários:

• legs – Array de objetos, onde cada objeto representa um trecho da rota. Caso queira calcular o pedágio para veículos diferentes em cada parte da rota, por exemplo, você pode dividi-la em várias legs. (Obrigatório apenas para o endpoint independente)
  • points – Coordenadas que compõem o trecho da rota. O parâmetro points aceita as coordenadas como objetos, arrays, codificadas em geohash ou codificadas como polyline, conforme os exemplos abaixo.
    
  • vehicleType – Texto que define o tipo de veículo a ser considerado para calcular o pedágio. Os valores possíveis são:
    • 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 – Data e hora em que a rota será realizada, no formato timestamp em milissegundos. Exemplo: 1583492400000
    
  • condition – (Opcional) Objeto que indica quais valores devem ser considerados para pedágios onde existem valores condicionais, como por exemplo valor com desconto para veículos com tag ou valor especifíco para feriados. O objeto é composto por:
    • billingType – Indica o tipo de cobrança que deve ser considerado. Os valores possíveis são: [ TAG, NORMAL ];
    • period – Indica o período que deve ser considerado para retornar o valor exato do pedágio. Os valores possíves são: [ NORMAL, HOLIDAY, LOW_SEASON, HIGH_SEASON ].

Formatos de coordenadas aceitos

Os seguintes formatos são suportados como entrada das coordenadas no parâmetro points:

Objeto – Objetos compostos pelos parâmetros latitude e longitude:

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

Array – Arrays contendo a latitude e longitude respectivamente:

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

Geohash – Strings com a latitude e longitude codificadas em geohash:

"points": [
	"6sx1j15pf",
]

Polyline – String com todas as coordenadas da rota codificadas como polyline:

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

Exemplo com parâmetros obrigatórios

{
    "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 opcionais

• source – Indica em qual base de coordenadas os pedágios devem ser consultados. Os valores possíveis são:
  • MAPLINK – Valor padrão, caso o parâmetro não seja informado;
  • GMAPS – Deve ser utilizado caso a rota a ser consultado tenha sido gerada pela Routes API do Google.
• transponderOperators – Apenas para rotas no Brasil. Array que indica quais códigos de integração deverão ser retornados, além do código ANTT que sempre será retornado. Os valores possíveis são:
  • CONECTCAR – O código do serviço da Conectcar será retornado;
  • SEM_PARAR – Os códigos dos serviços da Sem Parar serão retornados: Via Fácil e Sem Parar Pay.
• excludedTollTypes – Array com tipos de pedágios a serem desconsiderados na rota. Quando informado, pedágios dos tipos listados serão ignorados, tanto na listagem quanto no custo total. Os valores possíveis são:
  • TOLL_BOOTH – Praça de pedágio convencional;
  • TOLL_GANTRY – Pórtico eletrônico;
  • MUNICIPAL_TOLL_BOOTH – Pedágio municipal;
  • ENTRY_GANTRY – Pórtico de entrada (sistema free-flow);
  • EXIT_GANTRY – Pórtico de saída (sistema free-flow).
• multiplier – Parâmetro que recebe um número inteiro e atua como fator multiplicador ao valor base dos pedágios elegíveis ao cálculo, como por exemplo os pórticos free-flow da Via Dutra. O valor máximo aceito é 13.

Exemplo com parâmetros opcionais

{
    "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"
            },
            "multiplier": 5
        }
    ],
    "transponderOperators": [
        "CONECTCAR",
        "SEM_PARAR"
    ],
    "excludedTollTypes": [
        "MUNICIPAL_TOLL_BOOTH"
    ],
    "source": "MAPLINK"
}