Lista de parâmetros
Parâmetros obrigatórios
Os seguintes parâmetros são necessários:
legs
– Array compoints
evehicleType
para serem calculados os pedágios. Cadaleg
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áriaslegs
. (Obrigatório apenas para o endpoint independente)points
– Coordenadas que compõem o trecho da rota. O parâmetropoints
aceita as coordenadas como objetos, arrays, codificadas emgeohash
ou codificadas comopolyline
, 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
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.
billing
– Texto que indica o tipo de cobrança de pedágio. Os valores possíveis são:DEFAULT
– É o valor padrão caso o parâmetro não seja informado e indica que o cálculo de cobrança convencional de pedágios será utilizado, ou seja, apenas as praças de pedágio e pórticos convencionais serão retornados;FREE_FLOW
– Além das praças de pedágio e pórticos convencionais, também serão retornados os pórticos que fazem parte do sistema PaP ou Free Flow, hoje disponíveis em alguma rodovias no Brasil.
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.
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" } ], "billing": "DEFAULT", "transponderOperators": [ "CONECTCAR", "SEM_PARAR" ], "source": "MAPLINK" }