Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

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

...

  • 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 - (opcionalOpcional) 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.

...