Parâmetros obrigatórios

• points – Array de objetos, onde cada objeto representa um ponto de parada na rota com os seguintes campos:
  • siteId – Identificador do ponto de parada.
  • latitude – Coordenada da latitude em graus decimais.
  • longitude – Coordenada da longitude em graus decimais.

Exemplo:

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

Parâmetros opcionais

• calculationMode – Indica o modo de cálculo para a roteirização. Suporta os tipos:
  • THE_FASTEST – Considera o caminho mais rápido. Valor padrão.
  • THE_SHORTEST – Considera o caminho com menor quilometragem.
• vehicleType – Tipo do veículo que será usado na rota. O peso, altura e características específicas do veículo serão considerados para retornar a rota apropriada. O valor padrão, caso o parâmetro não seja informado, é TRUCK_WITH_TWO_DOUBLE_AXLES. 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
• avoidanceTypes – Indica que a rota deverá desviar de determinados tipos de elementos do sistema viário. Valores permitidos são:
  • TUNNELS – A rota irá desviar de túneis;
  • BRIDGES – A rota irá desviar de pontes;
  • FERRIES – A rota irá desviar de balsas.
• avoidanceBehavior – Indica qual deve ser o comportamento do roteirizador caso a rota possua elementos viários que devem ser evitados declarados em avoidanceTypes. Valores permitidos são:
  • FAIL – Comportamento padrão da API se o parâmetro não for informado. Caso não seja possível realizar uma rota sem passar por um elemento a ser evitado, será retornado uma mensagem de erro. Por exemplo, uma mensagem de erro será retornada ao usar "avoidanceTypes":["FERRIES"] em uma rota onde um dos pontos só pode ser acessado com balsa;
  • STRONG – Os elementos serão evitados, mas caso não seja possível realizar a rota sem passar por algum dos elementos, a rota mesmo assim será retornada. Por exemplo, uma rota onde um dos pontos só pode ser acessado com balsa será retornada mesmo utilizando o "avoidanceTypes":["FERRIES"] ;
  • RELAXED – Os elementos viários não serão completamente evitados, mas será priorizado a rota com a menor quantidade desses elementos.
• 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 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 – (Opcional) Array que indica quais códigos de integração deverão ser retornados, além do código ANTT. 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;
  • 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
• 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 – Retorna as cidades cruzadas pela rota.
    • STATE – Retorna os estados cruzados pela rota.
    • NONE – O parâmetro não será utilizado.
  • reverseGeocode – Será usado a Reverse Geocode API 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.
• 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 webhook precise de autenticação.
  • password – Texto com a senha caso o endpoint precise 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:
  • bufferRouteInMeters – Número inteiro com o raio de busca de pontos de interesse ao longo da rota. Limite de 500 metros.
  • bufferStoppingPointsInMeters – Número inteiro com o raio de busca de pontos de interesse nos pontos de paradas. Limite de 500 metros.
  • onlyMyPlaces – Valor booleano que indica se apenas os estabelecimentos da sua base própria serão retornados ou base nativa do serviço também deve ser usada. Para saber mais, consulte a documentação da POIs API.
  • categories – Array com as categorias dos estabelecimentos desejados.
  • subCategories – (Opcional) Array com as subcategorias dos estabelecimentos desejados.
• turnByTurn – Objeto onde serão especificadas as preferências relacionadas ao rotograma:
  • language – String que representa o idioma em que as instruções devem ser retornadas, seguindo a convenção pt_BR, es_EN, es_AR, en e assim por diante.

Abaixo um exemplo com todos os parâmetros opcionais:

{
     "calculationMode": "THE_FASTEST",
     "vehicleType": "CAR",
     "points": [
        {
            "siteId": "Point 1-Extrema",
            "latitude": -22.859246,
            "longitude": -46.339289
        },
        {
            "siteId": "Point 2-Betim",
            "latitude": -19.985117,
            "longitude": -44.202667
        }
    ],
    "avoidanceTypes":["FERRIES"],
    "avoidanceBehavior": "STRONG",    
    "toll": {
        "vehicleType": "CAR",
        "billing": "DEFAULT",
        "transponderOperators": ["CONECTCAR","SEM_PARAR"]
    },
    "place": {
        "categories": [
            "ALIMENTOS_E_BEBIDAS",
            "ACADEMIAS"
        ],
        "bufferRouteInMeters": 500,
        "bufferStoppingPointsInMeters": 500,
        "onlyMyPlaces": true,
    },
    "crossedBorders": {
        "level": "CITY",
        "reverseGeocode": "START_END_LEGS"
    },
    "restrictionZones": [
        "MG_BR381_530_km_AltCentl_5_75",
        "MG_BR381_620_km_AltCentl_5_61"
    ],
    "turnByTurn":{
        "language":"pt_BR"
    }
 }