Table of Contents |
---|
Construindo requisições para Toll API
Para realizar a requisição para a API é necessário usar o método POST/calculations:
Code Block | ||
---|---|---|
| ||
https://api.maplink.global/toll/v1/calculations |
os seguintes headers são necessários
Code Block |
---|
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' |
Onde Token é o access token obtido na autenticação.
Em body são enviados todos os parâmetros para calcular o pedágio da rota.
Body e Parâmetros da Request
A lista dos parâmetros estão descritos separados pelos grupos que eles pertencem.
Parâmetros Obrigatórios:
...
Os seguintes parâmetros são necessários:
legs
- Array compoints
evehicleType
para serem calculados os pedágios.points
: Coordenadas da polilinha:latitude
: coordenada da latitude em graus decimais.longitude
: coordenada da longitude em graus decimais.
vehicleType
: Texto que define o tipo de veículo a ser considerado para calcular o pedágio. Os valores possíveis são: [ CAR, MOTORCYCLE, 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_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_NINE_DOUBLE_AXLES ]
...
Cada
leg
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âmetropoints
aceita as coordenadas como objetos, arrays, codificadas em geohash ou codificadas como polyline, conforme os exemplos abaixo:Objeto - Objetos compostos pelos parâmetros latitude e longitude:
Code Block language json
...
"points": [
...
...
{
...
"latitude": -
...
19.
...
50489,
...
...
"longitude": -
...
57.43231
...
}
...
Info |
---|
Nota: A maneira mais prática de processar a Toll é obter o resultado da Trip API e adicionar o |
Parâmetros Opcionais:
billing
:]
Array - Arrays contendo a latitude e longitude:
Code Block language json "points": [ [-19.50489,-57.43231], ]
Geohash - Strings com a latitude e longitude codificadas em geohash:
Code Block language json "points": [ "6sx1j15pf", ]
Polyline - String com todas as coordenadas da rota codificadas como polyline:
Code Block language json "points": "pp`vB|fp}IlAFhCI"
billing
- Texto que indica o tipo de cobrança de pedágio. Valores Os valores possíveis são [ DEFAULT, FREE_FLOW]. O DEFAULT é :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 nas praças de pedágio.
FREE_FLOW
- Indica que será calculado os valores de pedágios em trechos de rodovias que possuam tanto o sistema de livre de passagem (onde existir pórticos
ou praças de pedágio) quanto o sistema convencional (praças de pedágio).
Info |
---|
Até a data deste documento, o sistema livre de passsagem em pedágio tem em São Paulo, as experiências com Free Flow em fase piloto e se aplicam nas rodovias:
O uso é mediante cadastro dos usuários portadores de TAG diretamente com as concessionárias. Apenas a SP-340 que permite o cadastro para qualquer usuário e veículo da rodovia. Enquanto nas outras é disponível a apenas para moradores das cidades vizinhas e veículos de Categoria 1. |
source
: Texto que indica qual o mapa base a ser usado de referência para o pedágio. Valores possíveis são [ DEFAULT, OSM, MAPLINK ]. Até a data deste texto, 12/04/2021, o DEFAULT e NULL utiliza o mapa Tom Tom; MAPLINK e OSM utilizam o mapa OSM.
Info |
---|
Nota: Utilizar em |
Exemplo de requisição com parâmetros opcionais:
...
language | json |
---|
...
vehicleType
- Texto que define o tipo de veículo a ser considerado para calcular o pedágio. Os valores possíveis são:CAR
MOTORCYCLE
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_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_NINE_DOUBLE_AXLES
TRUCK_WITH_TEN_DOUBLE_AXLES