2.2. Parâmetros da requisição

Parâmetros Obrigatórios

calculationMode - Indica o modo de cálculo para a rota. Suporta os tipos:
- THE_FASTEST - Considera o caminho mais rápido.
- THE_SHORTEST - Considera o caminho com menor quilometragem.
points -Descrição dos pontos de parada com:
- siteId - Identificador do ponto de parada.
- latitude - Coordenada da latitude em graus decimais.
- longitude - Coordenada da longitude em graus decimais.

Exemplo de requisição com parâmetros obrigatórios

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

Parâmetros Opcionais

toll - Indica que a rota deverá informar o cálculo do pedágio. Necessário informar os seguintes parâmetros:
- 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 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).
- 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

crossedBorders - Indica que algumas informações sobre a rota também devem ser retornadas:
- level - Será retornado as cidades ou estados que a rota cruza. Valores possíveis:
  - CITY - Retornar as cidades cruzadas pela rota.
  - STATE - Retornar os estados cruzados pela rota.
  - NONE - O parâmetro não será utilizado.
- reverseGeocode - Será usado a Reverse Geocode para retornar mais informações sobre pontos importantes da rota. Valores possíveis;
  - START_END - Será retornado os campos startAddress e endAddress com informações do primeiro e último pontos da rota.
  - START_END_LEGS - Será retornado o campo firstPointAddress dentro de cada leg (trecho da rota), com informações do ponto de início da leg em questão.
avoidanceTypes - Indica que a rota deverá desviar de determinados tipos de elementos do sistema viário. Valores permitidos são: [TUNNELS, BRIDGES, FERRIES, TOLL_ROADS, TOLL_GATES].
callback - Disponível apenas na Trip Assíncrona. Contém os dados do callback que é uma URL de webhook para receber os eventos do cálculo do problema. Os argumentos possíveis são:
- url - URL com o endereço que irá receber o callback.
- user - Texto com o nome do usuário caso o endpoint precisar de autenticação.
- password - Texto com a senha caso o endpoint precisar de autenticação.
restrictionZones - Array com o texto do nome da área de restrição previamente cadastrada na Restriction Zone API.
place - Usado para retornar pontos de interesse (POIs) presentes na rota. Necessário informar os seguintes parâmetros:
- categories - Categoria do estabelecimento desejado.
- subCategories - (Opcional) Subcategoria do estabelecimento desejado.
- bufferRouteInMeters - Número inteiro com o raio de busca de POIs ao longo da rota. Limite de 500 metros.
- bufferStoppingPointsInMeters - Número inteiro com o raio de busca de POIs nos pontos de paradas. Limite de 500 metros.

Para consultar as categorias e subcategorias disponíveis para consulta e cadastro, basta os seguintes endpoins (método GET):

Exemplo de requisição com parâmetros opcionais

{
    "calculationMode": "THE_FASTEST",
    "points": [
        {
            "siteId": "Point 1-Extrema",
            "latitude": -22.859246,
            "longitude": -46.339289
        },
        {
            "siteId": "Point 2-Betim",
            "latitude": -19.985117,
            "longitude": -44.202667
        }
    ],    
    "toll": {
        "billing": "DEFAULT",
        "vehicleType": "CAR"
    },
    "crossedBorders": { 
        "level": "CITY",
        "reverseGeocode": "START_END_LEGS"
    },
    "restrictionZones": [
        "MG_BR381_530_km_AltCentl_5_75",
        "MG_BR381_620_km_AltCentl_5_61"
    ],
    "place": {
        "categories": [
          "FISCALIZACAO"
        ],
        "bufferRouteInMeters": 10,
        "bufferStoppingPointsInMeters": 20
    }
}

Ver Mais em: