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.
• destinations – Descrição dos pontos de destino com:
  • siteId – Identificador do ponto de parada.
  • latitude – Coordenada da latitude em graus decimais.
  • longitude – Coordenada da longitude em graus decimais.
• origins – Descrição dos pontos de origem com:
  • siteId – Identificador do ponto de parada.
  • latitude – Coordenada da latitude em graus decimais.
  • longitude – Coordenada da longitude em graus decimais.
• tripProfile – Identificador do perfil para realizar a rota. Os valores possíveis são:
  • MAPLINKBR – O cálculo de distância será feito considerando as vias, porém apenas para rotas localizadas no Brasil.
  • MAPLINK – O cálculo de distância será feito considerando as vias, porém apenas para rotas localizadas na América Latina.
  • FAST – O cálculo de distância será feito considerando as vias, porém pontos acima de um limite de quilometragem serão calculados de forma linear. Esse limite é configurado pelo parâmetro linearThreshold.

Exemplo com parâmetros obrigatórios

{
    "calculationMode": "THE_FASTEST",
    "destinations": [
        {
            "latitude": -23.561402303338195, 
            "longitude": -46.63862145421187,
            "siteId": "destination1Liberdade"
        }
    ],
    "origins": [
        {
            "latitude": -23.55363650451996,
            "longitude": -46.620810158377516,
            "siteId": "origin1Mooca"
        }
    ],
    "tripProfile": "MAPLINKBR"
}

Parâmetros Opcionais

• linearThreshold – Valor numérico. Indica o limite de distância, em quilometros, para que o cálculo de distâncias seja feito considerando as vias, ao invés de linear.
• avoidanceTypes – Indica que a rota deverá desviar de determinados tipos de elementos do sistema viário. Valores permitidos são: [TUNNELS, BRIDGES, FERRIES].
• callback – Objeto que contém os dados do webhook que será utilizado para receber os eventos do cálculo do problema. Assim não será necessário consultar o status do problema para verificar se o mesmo foi processado. A API irá notificar o webhook quando a solução estiver disponível para consulta. Para mais detalhes, veja: Como receber o estado atual do problema via webhook?
  • url – URL com o endereço que irá receber o callback.
  • user – (Opcional) Texto com o nome do usuário caso o endpoint precisar de autenticação.
  • password – (Opcional) 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.

Exemplo com parâmetros opcionais

{
    "avoidanceTypes": [
        "TUNNELS",
        "BRIDGES",
        "FERRIES"
    ],
    "calculationMode": "THE_FASTEST",
    "destinations": [
        {
            "latitude": -23.682211,
            "longitude": -46.546867,
            "siteId": "SantoAndre"
        }
    ],
    "origins": [
        {
            "latitude": -23.337132,
            "longitude": -46.835427,
            "siteId": "Cajamar"
        }
    ],
    "linearThreshold": 500,
    "restrictionZones": [],
    "tripProfile": "FAST"
}