Compartilhar via


Route - Post Route Directions

Use para calcular uma rota entre uma determinada origem e um destino, passando por quaisquer pontos de passagem especificados.

A API Post Route Directions é uma solicitação HTTP POST que retorna uma rota entre uma origem e um destino, passando pelos pontos de passagem se forem especificados. A rota levará em conta fatores como o tráfego atual e as velocidades típicas da estrada no dia solicitado da semana e hora do dia.

As informações retornadas incluem a distância, o tempo de viagem estimado e uma representação da geometria da rota. Informações adicionais de roteamento, como ordem de ponto de passagem otimizada ou ativação por turno, também estão disponíveis, dependendo das opções selecionadas.

O serviço de roteamento fornece um conjunto de parâmetros para uma descrição detalhada de um modelo de consumo específico do veículo. Verifique do Modelo de Consumo para obter uma explicação detalhada dos conceitos e parâmetros envolvidos.

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
format
path True

ResponseFormat

Formato desejado da resposta. O valor pode ser json ouxml .

api-version
query True

string

Número de versão da API do Azure Mapas.

query
query True

string

As Coordenadas pelas quais a rota é calculada, delimitada por dois-pontos. Um mínimo de duas coordenadas é necessário. A primeira é a origem e a última é o destino da rota. As coordenadas opcionais no meio atuam como WayPoints na rota. Você pode passar até 150 WayPoints.

accelerationEfficiency
query

number

double

Especifica a eficiência da conversão de energia química armazenada em combustível em energia cinética quando o veículo acelera (ou seja, KineticEnergyGained/ChemicalEnergyConsumed). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com decelerationEfficiency.

O intervalo de valores permitidos é de 0,0 a 1/decelerationEfficiency.

Valores sensatos: para modelo de combustão: 0,33, para modelo elétrico: 0,66

alternativeType
query

AlternativeRouteType

Controla a otimização, em relação aos critérios de planejamento determinados, das alternativas calculadas em comparação com a rota de referência.

arriveAt
query

string

date-time

A data e hora de chegada no ponto de destino formatado como um valor dateTime, conforme definido em RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de destino.

Exemplos:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

O parâmetro arriveAt não pode ser usado em conjunto com departAt, minDeviationDistance ou minDeviationTime.

auxiliaryPowerInkW
query

number

double

Especifica a quantidade de energia consumida para sustentar sistemas auxiliares, em quilowatts (kW).

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas como sistemas AC, rádio, aquecimento etc.

Valores sensatos: 1,7

auxiliaryPowerInLitersPerHour
query

number

double

Especifica a quantidade de combustível consumida para manutenção de sistemas auxiliares do veículo, em litros por hora.

Ele pode ser usado para especificar o consumo devido a dispositivos e sistemas como sistemas AC, rádio, aquecimento etc.

Valores sensatos: 0.2

avoid
query

RouteAvoidType[]

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.

computeBestOrder
query

boolean

Solicite novamente os pontos de passagem de rota usando um algoritmo heurístico rápido para reduzir o comprimento da rota. Gera melhores resultados quando usado em conjunto com routeType mais curto. Observe que a origem e o destino são excluídos dos índices de ponto de passagem otimizados. Para incluir a origem e o destino na resposta, aumente todos os índices em 1 para considerar a origem e adicione o destino como o índice final. Os valores possíveis são verdadeiros ou falsos. True calcula uma ordem melhor se possível, mas não é permitido ser usado em conjunto com o valor maxAlternatives maior que 0 ou em conjunto com pontos de passagem de círculo. False usará os locais na ordem fornecida e não poderá ser usado em conjunto com routeRepresentation nenhum.

computeTravelTimeFor
query

ComputeTravelTime

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.

constantSpeedConsumptionInkWhPerHundredkm
query

string

Especifica o componente dependente de velocidade do consumo.

Fornecida como uma lista não ordenada de pares de velocidade/taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira:

  • por interpolação linear, se a velocidade determinada estiver entre duas velocidades na lista

  • por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista

A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional.

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em kWh/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,8,2:130,21,3

Esse parâmetro é necessário para modelo de consumo elétrico.

constantSpeedConsumptionInLitersPerHundredkm
query

string

Especifica o componente dependente de velocidade do consumo.

Fornecida como uma lista não ordenada de velocidade delimitada por dois-pontos & pares de taxa de consumo. A lista define pontos em uma curva de consumo. As taxas de consumo para velocidades que não estão na lista são encontradas da seguinte maneira:

  • por interpolação linear, se a velocidade determinada estiver entre duas velocidades na lista

  • por extrapolação linear caso contrário, supondo uma constante (ΔConsumption/ΔSpeed) determinada pelos dois pontos mais próximos na lista

A lista deve conter entre 1 e 25 pontos (inclusive) e pode não conter pontos duplicados para a mesma velocidade. Se ele contiver apenas um ponto, a taxa de consumo desse ponto será usada sem processamento adicional.

O consumo especificado para a maior velocidade deve ser maior ou igual ao da penúltima maior velocidade. Isso garante que a extrapolação não leve a taxas de consumo negativas.

Da mesma forma, os valores de consumo especificados para as duas menores velocidades da lista não podem levar a uma taxa de consumo negativa para qualquer velocidade menor.

O intervalo válido para os valores de consumo (expressos em l/100km) está entre 0,01 e 1000000,0.

Valores sensatos: 50,6,3:130,11,5

Observação: esse parâmetro é necessário para o modelo de consumo de combustão.

currentChargeInkWh
query

number

double

Especifica o fornecimento atual de energia elétrica em quilowatts-hora (kWh).

Esse parâmetro coexiste com parâmetro maxChargeInkWh.

O intervalo de valores permitidos é de 0,0 a maxChargeInkWh.

Valores sensatos: 43

currentFuelInLiters
query

number

double

Especifica o fornecimento atual de combustível em litros.

Valores sensatos: 55

decelerationEfficiency
query

number

double

Especifica a eficiência da conversão de energia cinética para o combustível salvo (não consumido) quando o veículo desacelera (ou seja, ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com de aceleração.

O intervalo de valores permitidos é de 0,0 a 1/de aceleração.

Valores sensatos: para modelo de combustão: 0,83, para modelo elétrico: 0,91

departAt
query

string

date-time

A data e hora da partida do ponto de origem formatado como um valor dateTime conforme definido em RFC 3339, seção 5.6, com um deslocamento de fuso horário opcional. Quando um deslocamento de fuso horário não for especificado, ele será considerado o do ponto de origem.

  • Valor padrão: agora
  • Outro valor: dateTime

Exemplos:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

O parâmetro departAt não pode ser usado em conjunto com arriveAt.

downhillEfficiency
query

number

double

Especifica a eficiência da conversão de energia potencial para o combustível salvo (não consumido) quando o veículo perde a elevação (ou seja, ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved é obtido convertendo combustível salvo (não consumido) em energia usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com uphillEfficiency.

O intervalo de valores permitidos é de 0,0 a 1/uphillEfficiency.

Valores sensatos: para modelo de combustão: 0,51, para modelo elétrico: 0,73

fuelEnergyDensityInMJoulesPerLiter
query

number

double

Especifica a quantidade de energia química armazenada em um litro de combustível em megajoules (MJ). Ele é usado em conjunto com os parâmetros *Efficiency para conversões entre energia e combustível salvos ou consumidos. Por exemplo, a densidade de energia é de 34,2 MJ/l para gasolina e 35,8 MJ/l para diesel.

Esse parâmetro será necessário se algum parâmetro *Efficiency estiver definido.

Valores sensatos: 34.2

hilliness
query

InclineLevel

Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

instructionsType
query

RouteInstructionsType

Se especificado, as instruções de diretriz serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.

language
query

string

O parâmetro de idioma determina o idioma das mensagens de orientação. Não afeta substantivos adequados (os nomes das ruas, praças etc.) Ele não tem efeito quando instructionsType=coded. Os valores permitidos são (um subconjunto de) as marcas de idioma IETF descritas

maxAlternatives
query

integer

Número de rotas alternativas desejadas a serem calculadas. Padrão: 0, mínimo: 0 e máximo: 5

maxChargeInkWh
query

number

double

Especifica o fornecimento máximo de energia elétrica em quilowatts-hora (kWh) que podem ser armazenados na bateria do veículo.

Esse parâmetro coexiste com parâmetro CurrentChargeInkWh.

O valor mínimo deve ser maior ou igual a CurrentChargeInkWh .

Valores sensatos: 85

minDeviationDistance
query

integer

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção POST Requests) do ponto de origem da solicitação calculateRoute para pelo menos esse número de medidores. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationDistance não pode ser usado em conjunto com arriveAt

minDeviationTime
query

integer

Todas as rotas alternativas retornadas seguirão a rota de referência (consulte a seção POST Requests) do ponto de origem da solicitação calculateRoute para pelo menos esse número de segundos. Só pode ser usado ao reconstruir uma rota. O parâmetro minDeviationTime não pode ser usado em conjunto com arriveAt. O valor padrão é 0. Definir )minDeviationTime_ para um valor maior que zero tem as seguintes consequências:

  • O ponto de origem do calculateRoute Request deve estar na (ou muito próxima) na rota de referência de entrada.
    • Se esse não for o caso, um erro será retornado.
    • No entanto, o ponto de origem não precisa estar no início da rota de referência de entrada (ele pode ser considerado como a posição atual do veículo na rota de referência).
  • A rota de referência, retornada como a primeira rota no calculateRoute Response, será iniciada no ponto de origem especificado no calculateRoute Request. A parte inicial da rota de referência de entrada até que o ponto de origem seja excluído da Resposta.
  • Os valores de minDeviationDistance e minDeviationTime determinar até que ponto as rotas alternativas serão garantidas para seguir a rota de referência do ponto de origem em diante.
  • A rota deve usar departAt.
  • O vehicleHeading é ignorado.
report
query

Report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.

routeRepresentation
query

RouteRepresentationForBestOrder

Especifica a representação do conjunto de rotas fornecidas como resposta.

routeType
query

RouteType

O tipo de rota solicitada.

sectionType
query

SectionType[]

Especifica quais dos tipos de seção são relatados na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro

traffic
query

boolean

Valores possíveis:

  • true – Considere todas as informações de tráfego disponíveis durante o roteamento
  • false – ignorar os dados de tráfego atuais durante o roteamento. Observe que, embora os dados de tráfego atuais sejam ignorados durante o roteamento, o efeito do tráfego histórico em velocidades de estrada efetivas ainda é incorporado.
travelMode
query

TravelMode

O modo de viagem para a rota solicitada. Se não for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.

uphillEfficiency
query

number

double

Especifica a eficiência da conversão de energia química armazenada em combustível em energia potencial quando o veículo ganha elevação (ou seja, PotentialEnergyGained/ChemicalEnergyConsumed). O ChemicalEnergyConsumed é obtido convertendo combustível consumido em energia química usando fuelEnergyDensityInMJoulesPerLiter.

Deve ser emparelhado com dede .

O intervalo de valores permitidos é de 0,0 a 1/de.

Valores sensatos: para modelo de combustão: 0,27, para modelo elétrico: 0,74

vehicleAxleWeight
query

integer

Peso por eixo do veículo em kg. Um valor de 0 significa que as restrições de peso por eixo não são consideradas.

vehicleCommercial
query

boolean

Se o veículo é usado para fins comerciais. Veículos comerciais podem não ter permissão para dirigir em algumas estradas.

vehicleEngineType
query

VehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.

vehicleHeading
query

integer

O título direcional do veículo em graus começando no verdadeiro Norte e continuando na direção horário. Norte é 0 graus, leste é 90 graus, sul é 180 graus, oeste é 270 graus. Valores possíveis 0-359

vehicleHeight
query

number

double

Altura do veículo em metros. Um valor de 0 significa que as restrições de altura não são consideradas.

vehicleLength
query

number

double

Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas.

vehicleLoadType
query

VehicleLoadType

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.

vehicleMaxSpeed
query

integer

Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é usada para verificar se um veículo é permitido em auto-estradas.

  • Um valor de 0 significa que um valor apropriado para o veículo será determinado e aplicado durante o planejamento da rota.

  • Um valor diferente de zero pode ser substituído durante o planejamento de rota. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo for definida como 50 km/hora, o motor de roteamento considerará 60 km/hora, pois essa é a situação atual. Se a velocidade máxima do veículo for fornecida como 80 km/hora, mas o fluxo de tráfego atual for de 60 km/hora, o mecanismo de roteamento usará novamente 60 km/hora.

vehicleWeight
query

integer

Peso do veículo em quilogramas.

  • É obrigatório se qualquer um dos parâmetros *Efficiency estiver definido.

  • Ele deve ser estritamente positivo quando usado no contexto do Modelo de Consumo. Restrições de peso são consideradas.

  • Se nenhum modelo de consumo detalhado for especificado e o valor de vehicleWeight não for zero, as restrições de peso serão consideradas.

  • Em todos os outros casos, esse parâmetro é ignorado.

Valores sensatos: para modelo de combustão: 1600, para modelo elétrico: 1900

vehicleWidth
query

number

double

Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas.

windingness
query

WindingnessLevel

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-id

string

Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança da ID do Microsoft Entra. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Corpo da solicitação

Nome Tipo Description
allowVignette

string[]

Esta é uma lista de códigos de país de 3 caracteres, ISO 3166-1, alfa-3 de países/regiões em que estradas pedagiadas com vinhetas são permitidas, por exemplo, "AUS,CHE". Especificar allowVignette com alguns países/regiões X equivale a especificar evitar vignette com todos os países/regiões, mas X. Especificar allowVignette com uma lista vazia é o mesmo que evitar todas as estradas pedagiadas com vinhetas. Observação: é um erro especificar evitar vignette e allowVignette.

avoidAreas

GeoJsonMultiPolygon

Um MultiPolygon GeoJSON que representa a lista de áreas a serem evitadas. Há suporte apenas para polígonos retângulos. O tamanho máximo de um retângulo é de cerca de 160 x 160 km. O número máximo de áreas evitadas é 10. Não pode atravessar o 180º meridiano. Deve estar entre -80 e +80 graus de latitude.

avoidVignette

string[]

Esta é uma lista de códigos de país 3 caracteres, ISO 3166-1, alfa-3 de países/regiões em que todas as estradas pedagiadas com vinhetas devem ser evitadas, por exemplo, "AUS,CHE". Estradas pedagiadas com vinhetas em países/regiões que não estão na lista não são afetadas. Observação: é um erro especificar evitar vignette e allowVignette.

supportingPoints

GeoJsonGeometryCollection

Uma coleção GeoJSON Geometry que representa a sequência de coordenadas usadas como entrada para reconstrução de rota e para calcular zero ou mais rotas alternativas para essa rota de referência.

  • A sequência fornecida de pontos de suporte é usada como entrada para reconstrução de rota.
  • As rotas alternativas são calculadas entre os pontos de origem e de destino especificados nos locais do parâmetro de caminho base.
  • Se minDeviationDistance e minDeviationTime estiverem definidos como zero, espera-se que esses pontos de origem e destino estejam no (ou muito próximo) no início e no final da rota de referência, respectivamente.
  • Não há suporte para locais intermediários (pontos de passagem) ao usar <>de pontos de suporte.
  • A rota de referência pode conter incidentes de tráfego do tipo ROAD_CLOSURE, que são ignorados para o cálculo do tempo de viagem e do atraso de tráfego da rota de referência. Consulte de Pontos de Suporte para obter detalhes.

Respostas

Nome Tipo Description
200 OK

RouteDirections

OKEY

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

Segurança

AADToken

Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.

Anotações

  • Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. * O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST. * O uso do SDK da Web do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

Essa é uma chave compartilhada provisionada quando você Criar uma conta do Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Successfully retrieve a route between an origin and a destination with additional parameters in the body

Solicitação de exemplo

POST https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

{
  "supportingPoints": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Point",
        "coordinates": [
          13.42936,
          52.5093
        ]
      },
      {
        "type": "Point",
        "coordinates": [
          13.42859,
          52.50844
        ]
      }
    ]
  },
  "avoidVignette": [
    "AUS",
    "CHE"
  ],
  "avoidAreas": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [
            -122.39456176757811,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.489368981370724
          ]
        ]
      ],
      [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    ]
  }
}

Resposta de exemplo

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

Definições

Nome Description
AlternativeRouteType

Controla a otimização, em relação aos critérios de planejamento determinados, das alternativas calculadas em comparação com a rota de referência.

ComputeTravelTime

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.

DelayMagnitude

A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API de Detalhes de Incidentes de Tráfego .

DrivingSide

Indica a direção esquerda versus direita no ponto da manobra.

EffectiveSetting

Parâmetro efetivo ou dados usados ao chamar essa API de Rota.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeoJsonGeometry

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

GeoJsonGeometryCollection

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.

GeoJsonLineString

Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.

GeoJsonMultiLineString

Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.

GeoJsonMultiPoint

Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.

GeoJsonMultiPolygon

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.

GeoJsonPoint

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

GeoJsonPolygon

Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.

GuidanceInstructionType

Tipo da instrução, por exemplo, girar ou alterar o formulário de estrada.

GuidanceManeuver

Um código que identifica a manobra.

InclineLevel

Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

JunctionType

O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.

LatLongPair

Um local representado como latitude e longitude.

Report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.

ResponseFormat

Formato desejado da resposta. O valor pode ser json ouxml .

ResponseSectionType

Tipos de seção da resposta de rota relatada

ResponseTravelMode

Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte solicitado não for possível nesta seção

Route
RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.

RouteDirectionParameters

Post body parameters for Route directions.

RouteDirections

Esse objeto é retornado de uma chamada bem-sucedida do Route Directions

RouteGuidance

Contém elementos relacionados à orientação. Esse campo só está presente quando as diretrizes foram solicitadas e estão disponíveis.

RouteInstruction

Um conjunto de atributos que descrevem uma manobra, por exemplo, "Virar à direita", "Manter a esquerda", "Pegar a balsa", "Pegar a auto-estrada", "Chegar".

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução relacionados uns aos outros. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o grupo de instruções tem uma mensagem de resumo retornada quando disponível.

RouteInstructionsType

Se especificado, as instruções de diretriz serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.

RouteLeg

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido na solicitação resultará em uma etapa adicional na rota retornada.

RouteLegSummary

Objeto resumo da seção de rota.

RouteOptimizedWaypoint

Objeto de ponto de passagem otimizado.

RouteReport

Relata as configurações efetivas usadas na chamada atual.

RouteRepresentationForBestOrder

Especifica a representação do conjunto de rotas fornecidas como resposta.

RouteSection

As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos startPointIndex, endPointIndexe sectionType.

RouteSectionTec

Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter effectCode e causa elementos.

RouteSectionTecCause

A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir a iconografia e as descrições.

RouteSummary

Objeto resumo

RouteType

O tipo de rota solicitada.

SectionType

Especifica quais dos tipos de seção são relatados na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro

SimpleCategory

Tipo do incidente. No momento, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Consulte "tec" para obter informações detalhadas.

TravelMode

O modo de viagem para a rota solicitada. Se não for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.

VehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.

VehicleLoadType

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.

WindingnessLevel

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

AlternativeRouteType

Controla a otimização, em relação aos critérios de planejamento determinados, das alternativas calculadas em comparação com a rota de referência.

Nome Tipo Description
anyRoute

string

Permitir que qualquer rota alternativa seja retornada independentemente de como ela se compara à rota de referência em termos de otimização.

betterRoute

string

Retorne uma rota alternativa somente se ela for melhor do que a rota de referência de acordo com os critérios de planejamento especificados.

ComputeTravelTime

Especifica se é necessário retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego (nenhum, histórico, ao vivo), bem como o tempo de viagem de melhor estimativa padrão.

Nome Tipo Description
all

string

Calcula os tempos de viagem para todos os tipos de informações de tráfego e especifica todos os resultados nos campos noTraffic TravelTimeInSeconds, historicTraffic TravelTimeInSeconds e liveTrafficIncidents TravelTimeInSeconds incluídos nos resumos na resposta da rota.

none

string

Não computa tempos de viagem adicionais.

DelayMagnitude

A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API de Detalhes de Incidentes de Tráfego .

Nome Tipo Description
0

string

Desconhecido.

1

string

Menor.

2

string

Moderado.

3

string

Principal.

4

string

Indefinido, usado para fechamentos de estradas e outros atrasos indefinidos.

DrivingSide

Indica a direção esquerda versus direita no ponto da manobra.

Nome Tipo Description
LEFT

string

Lado esquerdo.

RIGHT

string

Lado direito.

EffectiveSetting

Parâmetro efetivo ou dados usados ao chamar essa API de Rota.

Nome Tipo Description
key

string

Nome do parâmetro usado.

value

string

Valor do parâmetro usado.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeoJsonGeometry

Um objeto de geometria GeoJSON válido. O tipo deve ser um dos sete tipos de geometria GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon e GeometryCollection. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
type

GeoJsonObjectType

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonGeometryCollection

Um tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
geometries GeoJsonGeometry[]:

Contém uma lista de objetos de geometria GeoJSON válidos. Observação que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).

type string:

GeometryCollection

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonLineString

Um tipo de geometria de GeoJSON LineString válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a geometria GeoJson LineString.

type string:

LineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiLineString

Um tipo de geometria de GeoJSON MultiLineString válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a geometria GeoJson MultiLineString.

type string:

MultiLineString

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPoint

Um tipo de geometria de GeoJSON MultiPoint válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para a geometria GeoJson MultiPoint.

type string:

MultiPoint

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonMultiPolygon

Um tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Contém uma lista de objetos GeoJSON Polygon válidos. Observação que as coordenadas em GeoJSON estão em ordem x, y (longitude, latitude).

type string:

MultiPolygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPoint

Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Um Position é uma matriz de números com dois ou mais elementos. Os dois primeiros elementos são de longitude e de latitude, precisamente nessa ordem. altitude/elevação é um terceiro elemento opcional. Consulte RFC 7946 para obter detalhes.

type string:

Point

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GeoJsonPolygon

Um tipo de geometria de GeoJSON Polygon válido. Consulte RFC 7946 para obter detalhes.

Nome Tipo Description
coordinates

number[]

Coordenadas para o tipo de geometria GeoJson Polygon.

type string:

Polygon

Especifica o tipo de GeoJSON. Deve ser um dos nove tipos de objeto GeoJSON válidos – Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

GuidanceInstructionType

Tipo da instrução, por exemplo, girar ou alterar o formulário de estrada.

Nome Tipo Description
DIRECTION_INFO

string

Informações de direção.

LOCATION_ARRIVAL

string

Local de chegada.

LOCATION_DEPARTURE

string

Local de partida.

LOCATION_WAYPOINT

string

Localização do ponto de passagem.

ROAD_CHANGE

string

Mudança de estrada.

TURN

string

Virar.

GuidanceManeuver

Um código que identifica a manobra.

Nome Tipo Description
ARRIVE

string

Você chegou.

ARRIVE_LEFT

string

Você chegou. Seu destino é à esquerda.

ARRIVE_RIGHT

string

Você chegou. Seu destino está à direita.

BEAR_LEFT

string

Urso à esquerda.

BEAR_RIGHT

string

Urso direito.

DEPART

string

Deixar.

ENTER_FREEWAY

string

Pegue a auto-estrada.

ENTER_HIGHWAY

string

Pegue a estrada.

ENTER_MOTORWAY

string

Pegue a auto-estrada.

ENTRANCE_RAMP

string

Pegue a rampa.

FOLLOW

string

Seguir.

KEEP_LEFT

string

Mantenha-se à esquerda.

KEEP_RIGHT

string

Mantenha-se bem.

MAKE_UTURN

string

Faça um retorno.

MOTORWAY_EXIT_LEFT

string

Pegue a saída à esquerda.

MOTORWAY_EXIT_RIGHT

string

Pegue a saída para a direita.

ROUNDABOUT_BACK

string

Vá ao redor da rotatória.

ROUNDABOUT_CROSS

string

Cruze a rotatória.

ROUNDABOUT_LEFT

string

Na rotatória, pegue a saída à esquerda.

ROUNDABOUT_RIGHT

string

Na rotatória, pegue a saída à direita.

SHARP_LEFT

string

Vire para a esquerda afiada.

SHARP_RIGHT

string

Vire afiado para a direita.

STRAIGHT

string

Mantenha-se em linha reta.

SWITCH_MAIN_ROAD

string

Alterne para a estrada principal.

SWITCH_PARALLEL_ROAD

string

Alterne para a estrada paralela.

TAKE_EXIT

string

Pegue a saída.

TAKE_FERRY

string

Pegue a balsa.

TRY_MAKE_UTURN

string

Tente fazer um retorno.

TURN_LEFT

string

Vire para a esquerda.

TURN_RIGHT

string

Vire à direita.

WAYPOINT_LEFT

string

Você chegou ao ponto de passagem. Está à esquerda.

WAYPOINT_REACHED

string

Você chegou ao ponto de passagem.

WAYPOINT_RIGHT

string

Você chegou ao ponto de passagem. Está à direita.

InclineLevel

Grau de colina para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Nome Tipo Description
high

string

alto

low

string

baixo

normal

string

normal

JunctionType

O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.

Nome Tipo Description
BIFURCATION

string

bifurcação

REGULAR

string

regular

ROUNDABOUT

string

rotatória

LatLongPair

Um local representado como latitude e longitude.

Nome Tipo Description
latitude

number

Propriedade Latitude

longitude

number

Propriedade Longitude

Report

Especifica quais dados devem ser relatados para fins de diagnóstico. O único valor possível é effectiveSettings. Relata os parâmetros ou dados efetivos usados ao chamar a API. No caso de parâmetros padrão, o padrão será refletido em que o parâmetro não foi especificado pelo chamador.

Nome Tipo Description
effectiveSettings

string

Relata os parâmetros ou dados efetivos usados ao chamar a API.

ResponseFormat

Formato desejado da resposta. O valor pode ser json ouxml .

Nome Tipo Description
json

string

o formato de intercâmbio de dados de notação de objeto JavaScript

xml

string

a linguagem de marcação extensível

ResponseSectionType

Tipos de seção da resposta de rota relatada

Nome Tipo Description
CARPOOL

string

Seções da rota que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).

CAR_TRAIN

string

Seções da rota que são carros ou trens.

COUNTRY

string

Seções que indicam em quais países/regiões a rota está.

FERRY

string

Seções da rota que são balsas.

MOTORWAY

string

Seções da rota que são auto-estradas.

PEDESTRIAN

string

Seções da rota que são adequadas apenas para pedestres.

TOLL_ROAD

string

Seções da rota que exigem um pedágio a ser pago.

TOLL_VIGNETTE

string

Seções da rota que exigem uma vinheta de pedágio para estar presente.

TRAFFIC

string

Seções da rota que contêm informações de tráfego.

TRAVEL_MODE

string

Seções em relação ao parâmetro de solicitação travelMode.

TUNNEL

string

Seções da rota que são túneis.

URBAN

string

Seções da rota que estão localizadas em áreas urbanas.

ResponseTravelMode

Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte solicitado não for possível nesta seção

Nome Tipo Description
bicycle

string

As rotas retornadas são otimizadas para bicicletas, incluindo o uso de ciclovias.

bus

string

As rotas retornadas são otimizadas para ônibus, incluindo o uso de faixas somente de ônibus. Funcionalidade BETA.

car

string

As rotas retornadas são otimizadas para carros.

motorcycle

string

As rotas retornadas são otimizadas para motocicletas. Funcionalidade BETA.

other

string

O modo de transporte determinado não é possível nesta seção

pedestrian

string

As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.

taxi

string

As rotas retornadas são otimizadas para táxis. Funcionalidade BETA.

truck

string

As rotas retornadas são otimizadas para veículos comerciais, como para caminhões.

van

string

As rotas retornadas são otimizadas para vans. Funcionalidade BETA.

Route

Nome Tipo Description
guidance

RouteGuidance

Contém elementos relacionados à orientação. Esse campo só está presente quando as diretrizes foram solicitadas e estão disponíveis.

legs

RouteLeg[]

Matriz de pernas

sections

RouteSection[]

Matriz de seções

summary

RouteSummary

Objeto resumo

RouteAvoidType

Especifica algo que o cálculo de rota deve tentar evitar ao determinar a rota. Pode ser especificado várias vezes em uma solicitação, por exemplo, '&avoid=motorways&avoid=tollRoads&avoid=ferries'. Em solicitações de Intervalo de Rotas, o valor alreadyUsedRoads não deve ser usado.

Nome Tipo Description
alreadyUsedRoads

string

Evita usar a mesma estrada várias vezes. Mais útil em conjunto com routeType=emocionante.

borderCrossings

string

Evita cruzamentos de borda no cálculo de rota.

carpools

string

Evita rotas que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).

ferries

string

Evita balsas

motorways

string

Evita auto-estradas

tollRoads

string

Evita estradas pedagiadas.

unpavedRoads

string

Evita estradas não pavimentadas

RouteDirectionParameters

Post body parameters for Route directions.

Nome Tipo Description
allowVignette

string[]

Esta é uma lista de códigos de país de 3 caracteres, ISO 3166-1, alfa-3 de países/regiões em que estradas pedagiadas com vinhetas são permitidas, por exemplo, "AUS,CHE". Especificar allowVignette com alguns países/regiões X equivale a especificar evitar vignette com todos os países/regiões, mas X. Especificar allowVignette com uma lista vazia é o mesmo que evitar todas as estradas pedagiadas com vinhetas. Observação: é um erro especificar evitar vignette e allowVignette.

avoidAreas

GeoJsonMultiPolygon

Um MultiPolygon GeoJSON que representa a lista de áreas a serem evitadas. Há suporte apenas para polígonos retângulos. O tamanho máximo de um retângulo é de cerca de 160 x 160 km. O número máximo de áreas evitadas é 10. Não pode atravessar o 180º meridiano. Deve estar entre -80 e +80 graus de latitude.

avoidVignette

string[]

Esta é uma lista de códigos de país 3 caracteres, ISO 3166-1, alfa-3 de países/regiões em que todas as estradas pedagiadas com vinhetas devem ser evitadas, por exemplo, "AUS,CHE". Estradas pedagiadas com vinhetas em países/regiões que não estão na lista não são afetadas. Observação: é um erro especificar evitar vignette e allowVignette.

supportingPoints

GeoJsonGeometryCollection

Uma coleção GeoJSON Geometry que representa a sequência de coordenadas usadas como entrada para reconstrução de rota e para calcular zero ou mais rotas alternativas para essa rota de referência.

  • A sequência fornecida de pontos de suporte é usada como entrada para reconstrução de rota.
  • As rotas alternativas são calculadas entre os pontos de origem e de destino especificados nos locais do parâmetro de caminho base.
  • Se minDeviationDistance e minDeviationTime estiverem definidos como zero, espera-se que esses pontos de origem e destino estejam no (ou muito próximo) no início e no final da rota de referência, respectivamente.
  • Não há suporte para locais intermediários (pontos de passagem) ao usar <>de pontos de suporte.
  • A rota de referência pode conter incidentes de tráfego do tipo ROAD_CLOSURE, que são ignorados para o cálculo do tempo de viagem e do atraso de tráfego da rota de referência. Consulte de Pontos de Suporte para obter detalhes.

RouteDirections

Esse objeto é retornado de uma chamada bem-sucedida do Route Directions

Nome Tipo Description
formatVersion

string

Propriedade Format Version

optimizedWaypoints

RouteOptimizedWaypoint[]

Sequência otimizada de pontos de passagem. Ele mostra o índice da sequência de pontos de passagem fornecida pelo usuário para a lista original e otimizada. Por exemplo, uma resposta:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

significa que a sequência original é [0, 1, 2] e a sequência otimizada é [1, 2, 0]. Como o índice começa em 0, o original é "primeiro, segundo, terceiro" enquanto o otimizado é "segundo, terceiro, primeiro".

report

RouteReport

Relata as configurações efetivas usadas na chamada atual.

routes

Route[]

Matriz de rotas

RouteGuidance

Contém elementos relacionados à orientação. Esse campo só está presente quando as diretrizes foram solicitadas e estão disponíveis.

Nome Tipo Description
instructionGroups

RouteInstructionGroup[]

Agrupa uma sequência de elementos de instrução relacionados uns aos outros.

instructions

RouteInstruction[]

Uma lista de instruções que descrevem manobras.

RouteInstruction

Um conjunto de atributos que descrevem uma manobra, por exemplo, "Virar à direita", "Manter a esquerda", "Pegar a balsa", "Pegar a auto-estrada", "Chegar".

Nome Tipo Description
combinedMessage

string

Uma mensagem legível para a manobra combinada com a mensagem da próxima instrução. Às vezes, é possível combinar duas instruções sucessivas em uma única instrução, facilitando a execução. Quando esse for o caso, o sinalizador possibleCombineWithNext será verdadeiro. Por exemplo:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

O possível sinalizadorCombineWithNext na instrução 10 é verdadeiro. Isso indica aos clientes de diretrizes codificadas que ele pode ser combinado com a instrução 11. As instruções serão combinadas automaticamente para clientes que solicitam orientação legível por humanos. O campo combinedMessage contém a mensagem combinada:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

Código de país alfa-3 de 3 caracteres ISO 3166-1. Por exemplo, EUA.

drivingSide

DrivingSide

Indica a direção esquerda versus direita no ponto da manobra.

exitNumber

string

O número de uma saída da rodovia tomada pela manobra atual. Se uma saída tiver vários números de saída, eles serão separados por "," e possivelmente agregados por "-", por exemplo, "10, 13-15".

instructionType

GuidanceInstructionType

Tipo da instrução, por exemplo, girar ou alterar o formulário de estrada.

junctionType

JunctionType

O tipo da junção em que a manobra ocorre. Para rotatórias maiores, duas instruções separadas são geradas para entrar e sair da rotatória.

maneuver

GuidanceManeuver

Um código que identifica a manobra.

message

string

Uma mensagem legível para a manobra.

point

LatLongPair

Um local representado como latitude e longitude.

pointIndex

integer

O índice do ponto na lista de "pontos" de polilinha correspondente ao ponto da instrução.

possibleCombineWithNext

boolean

Opcionalmente, é possível combinar a instrução com a próxima. Isso pode ser usado para criar mensagens como "Virar para a esquerda e depois virar para a direita".

roadNumbers

string[]

O número da estrada dos próximos segmentos de estrada significativos após a manobra, ou das estradas a serem seguidas. Exemplo: ["E34", "N205"]

roundaboutExitNumber

integer

Isso indica qual saída tomar em uma rotatória.

routeOffsetInMeters

integer

Distância do início da rota até o ponto da instrução.

signpostText

string

O texto em uma placa de sinalização que é mais relevante para a manobra ou para a direção que deve ser seguida.

stateCode

string

Uma subdivisão (por exemplo, estado) do país, representada pela segunda parte de um código ISO 3166-2 . Isso só está disponível para alguns países/regiões, como EUA, Canadá e México.

street

string

Nome da rua do próximo segmento de estrada significativo após a manobra, ou da rua que deve ser seguida.

travelTimeInSeconds

integer

Tempo de viagem estimado até o ponto correspondente a routeOffsetInMeters.

turnAngleInDecimalDegrees

integer

Indica a direção de uma instrução. Se junctionType indicar uma instrução de turno:

  • 180 = U-turn
  • [-179, -1] = Curva à esquerda
  • 0 = Em linha reta (uma curva '0 graus')
  • [1, 179] = Curva à direita

Se junctionType indicar uma instrução de bifurcação:

  • <0 - mantenha-se à esquerda
  • >0 - mantenha a direita

RouteInstructionGroup

Agrupa uma sequência de elementos de instrução relacionados uns aos outros. O intervalo de sequência é restrito com firstInstructionIndex e lastInstructionIndex. Quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged), o grupo de instruções tem uma mensagem de resumo retornada quando disponível.

Nome Tipo Description
firstInstructionIndex

integer

Índice da primeira instrução nas instruções e pertencente a esse grupo.

groupLengthInMeters

integer

Comprimento do grupo.

groupMessage

string

Mensagem de resumo quando mensagens de texto legíveis por humanos são solicitadas para orientação (instructionType=text ou tagged).

lastInstructionIndex

integer

Índice da última instrução nas instruções e pertencente a esse grupo.

RouteInstructionsType

Se especificado, as instruções de diretriz serão retornadas. Observe que o parâmetro instructionsType não pode ser usado em conjunto com routeRepresentation=none.

Nome Tipo Description
coded

string

Retorna dados de instrução brutos sem mensagens legíveis por humanos.

tagged

string

Retorna dados de instrução brutos com mensagens legívels por humanos marcadas para permitir a formatação. Uma mensagem legível por humanos é criada com base em elementos identificados repetíveis. Eles são marcados para permitir que os aplicativos cliente os formatem corretamente. Os seguintes componentes de mensagem são marcados quando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Exemplo da mensagem "Virar à esquerda" marcada:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text

string

Retorna dados de instruções brutos com mensagens legíveis por humanos em texto sem formatação.

RouteLeg

Uma descrição de uma parte de uma rota, composta por uma lista de pontos. Cada ponto de passagem adicional fornecido na solicitação resultará em uma etapa adicional na rota retornada.

Nome Tipo Description
points

LatLongPair[]

Matriz de pontos

summary

RouteLegSummary

Objeto resumo da seção de rota.

RouteLegSummary

Objeto resumo da seção de rota.

Nome Tipo Description
arrivalTime

string

A hora de chegada estimada para a rota ou a perna. A hora está em UTC.

batteryConsumptionInkWh

number

Consumo estimado de energia elétrica em quilowatts-hora (kWh) usando o Modelo de Consumo Elétrico. Incluído se vehicleEngineType estiver definido como elétrico e constantSpeedConsumptionInkWhPerHundredkm for especificado. O valor de batteryConsumptionInkWh inclui a energia elétrica recuperada e, portanto, pode ser negativo (o que indica o ganho de energia). Se maxChargeInkWh e currentChargeInkWh forem especificados, a recuperação será limitada para garantir que o nível de carga da bateria nunca exceda maxChargeInkWh. Se nem maxChargeInkWh nem currentChargeInkWh forem especificados, a recuperação não treinada será assumida no cálculo de consumo.

departureTime

string

A hora de partida estimada para a rota ou a perna. A hora está em UTC.

fuelConsumptionInLiters

number

Consumo estimado de combustível em litros usando o Modelo de Consumo de Combustão. Incluído se vehicleEngineType estiver definido como de combustão e constantSpeedConsumptionInLitersPerHundredkm for especificado. O valor não será negativo.

historicTrafficTravelTimeInSeconds

integer

Tempo de viagem estimado calculado usando dados de tráfego histórico dependentes do tempo. Incluído somente se computeTravelTimeFor = tudo for usado na consulta.

lengthInMeters

integer

Propriedade Length In Meters

liveTrafficIncidentsTravelTimeInSeconds

integer

Tempo de viagem estimado calculado usando dados de velocidade em tempo real. Incluído somente se computeTravelTimeFor = tudo for usado na consulta.

noTrafficTravelTimeInSeconds

integer

Tempo de viagem estimado calculado como se não houvesse atrasos na rota devido às condições de tráfego (por exemplo, congestionamento). Incluído somente se computeTravelTimeFor = tudo for usado na consulta.

trafficDelayInSeconds

integer

Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com informações de tráfego. Para rotas planejadas com hora de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro compute TravelTimeFor=tudo precisa ser adicionado.

travelTimeInSeconds

integer

Propriedade estimada do tempo de viagem em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem será calculado usando dados de tráfego histórico dependentes do tempo.

RouteOptimizedWaypoint

Objeto de ponto de passagem otimizado.

Nome Tipo Description
optimizedIndex

integer

Índice de ponto de passagem otimizado do sistema.

providedIndex

integer

Índice de ponto de passagem fornecido pelo usuário.

RouteReport

Relata as configurações efetivas usadas na chamada atual.

Nome Tipo Description
effectiveSettings

EffectiveSetting[]

Parâmetros ou dados efetivos usados ao chamar essa API de Rota.

RouteRepresentationForBestOrder

Especifica a representação do conjunto de rotas fornecidas como resposta.

Nome Tipo Description
none

string

Inclui apenas os índices de ponto de passagem otimizados, mas não inclui a geometria de rota na resposta. Esse valor de parâmetro só pode ser usado em conjunto com computeBestOrder=true.

polyline

string

Inclui geometria de rota na resposta.

summaryOnly

string

Resumo de acordo com a polilinha, mas excluindo os elementos de geometria de ponto para as rotas na resposta.

RouteSection

As seções de rota contêm informações adicionais sobre partes de uma rota. Cada seção contém pelo menos os elementos startPointIndex, endPointIndexe sectionType.

Nome Tipo Description
delayInSeconds

integer

Atraso em segundos causado pelo incidente.

effectiveSpeedInKmh

integer

Velocidade efetiva do incidente em km/h, média em todo o seu comprimento.

endPointIndex

integer

Índice do último ponto (deslocamento 0) na rota à qual esta seção se aplica.

magnitudeOfDelay

DelayMagnitude

A magnitude do atraso causado pelo incidente. Esses valores correspondem aos valores do campo de resposta ty da API de Detalhes de Incidentes de Tráfego .

sectionType

ResponseSectionType

Tipos de seção da resposta de rota relatada

simpleCategory

SimpleCategory

Tipo do incidente. No momento, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Consulte "tec" para obter informações detalhadas.

startPointIndex

integer

Índice do primeiro ponto (deslocamento 0) na rota à qual esta seção se aplica.

tec

RouteSectionTec

Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter effectCode e causa elementos.

travelMode

ResponseTravelMode

Modo de viagem para a rota calculada. O valor será definido como other se o modo de transporte solicitado não for possível nesta seção

RouteSectionTec

Detalhes do evento de tráfego, usando definições no TPEG2-TEC padrão. Pode conter effectCode e causa elementos.

Nome Tipo Description
causes

RouteSectionTecCause[]

Matriz causas

effectCode

integer

O efeito no fluxo de tráfego. Contém um valor na tabela tec001:EffectCode, conforme definido no TPEG2-TEC padrão. Pode ser usado para eventos de tráfego de código de cor de acordo com a gravidade.

RouteSectionTecCause

A causa do evento de tráfego. Pode conter elementos mainCauseCode e subCauseCode. Pode ser usado para definir a iconografia e as descrições.

Nome Tipo Description
mainCauseCode

integer

A principal causa do evento de tráfego. Contém um valor na tabela tec002:CauseCode, conforme definido no padrão TPEG2-TEC.

subCauseCode

integer

O subcauso do evento de tráfego. Contém um valor na tabela de sub-causa definida pelo mainCauseCode, conforme definido no padrão TPEG2-TEC .

RouteSummary

Objeto resumo

Nome Tipo Description
arrivalTime

string

A hora de chegada estimada para a rota ou a perna. A hora está em UTC.

departureTime

string

A hora de partida estimada para a rota ou a perna. A hora está em UTC.

lengthInMeters

integer

Propriedade Length In Meters

trafficDelayInSeconds

integer

Atraso estimado em segundos causado pelos incidentes em tempo real, de acordo com informações de tráfego. Para rotas planejadas com hora de partida no futuro, os atrasos são sempre 0. Para retornar tempos de viagem adicionais usando diferentes tipos de informações de tráfego, o parâmetro compute TravelTimeFor=tudo precisa ser adicionado.

travelTimeInSeconds

integer

Propriedade estimada do tempo de viagem em segundos que inclui o atraso devido ao tráfego em tempo real. Observe que mesmo quando traffic=false travelTimeInSeconds ainda inclui o atraso devido ao tráfego. Se DepartAt estiver no futuro, o tempo de viagem será calculado usando dados de tráfego histórico dependentes do tempo.

RouteType

O tipo de rota solicitada.

Nome Tipo Description
eco

string

Uma rota equilibrada por economia e velocidade.

fastest

string

A rota mais rápida.

shortest

string

A rota mais curta por distância.

thrilling

string

Inclui estradas interessantes ou desafiadoras e usa o menor número possível de auto-estradas. Você pode escolher o nível de turnos incluído e também o grau de hilliness. Consulte os parâmetros de hilliness e windingness para saber como definir isso. Há um limite de 900 km em rotas planejadas com routeType=emocionante

SectionType

Especifica quais dos tipos de seção são relatados na resposta da rota.

Por exemplo, se sectionType = pedestre, as seções que são adequadas apenas para pedestres são retornadas. Pode ser especificado várias vezes em uma solicitação, por exemplo, '§ionType=carTrain§ionType=pedestrian§ionType=motorway'. O sectionType padrão refere-se à entrada travelMode. Por padrão, travelMode é definido como carro

Nome Tipo Description
carTrain

string

Seções da rota que são carros ou trens.

carpool

string

Seções da rota que exigem o uso de faixas de carona (HOV/Veículo de Alta Ocupação).

country

string

Seções que indicam em quais países/regiões a rota está.

ferry

string

Seções da rota que são balsas.

motorway

string

Seções da rota que são auto-estradas.

pedestrian

string

Seções da rota que são adequadas apenas para pedestres.

tollRoad

string

Seções da rota que exigem um pedágio a ser pago.

tollVignette

string

Seções da rota que exigem uma vinheta de pedágio para estar presente.

traffic

string

Seções da rota que contêm informações de tráfego.

travelMode

string

Seções em relação ao parâmetro de solicitação travelMode.

tunnel

string

Seções da rota que são túneis.

urban

string

Seções da rota que estão localizadas em áreas urbanas.

SimpleCategory

Tipo do incidente. No momento, pode ser JAM, ROAD_WORK, ROAD_CLOSURE ou OTHER. Consulte "tec" para obter informações detalhadas.

Nome Tipo Description
JAM

string

Engarrafamento.

OTHER

string

Outro.

ROAD_CLOSURE

string

Fechamento da estrada.

ROAD_WORK

string

Trabalho rodoviário.

TravelMode

O modo de viagem para a rota solicitada. Se não for definido, o padrão será "carro". Observe que o travelMode solicitado pode não estar disponível para toda a rota. Quando o travelMode solicitado não estiver disponível para uma seção específica, o elemento travelMode da resposta dessa seção será "outro". Observe que os modos de viagem de ônibus, moto, táxi e van são funcionalidade BETA. Os dados de restrição completa não estão disponíveis em todas as áreas.

Nome Tipo Description
bicycle

string

As rotas retornadas são otimizadas para bicicletas, incluindo o uso de ciclovias.

bus

string

As rotas retornadas são otimizadas para ônibus, incluindo o uso de faixas somente de ônibus. Funcionalidade BETA.

car

string

As rotas retornadas são otimizadas para carros.

motorcycle

string

As rotas retornadas são otimizadas para motocicletas. Funcionalidade BETA.

pedestrian

string

As rotas retornadas são otimizadas para pedestres, incluindo o uso de calçadas.

taxi

string

As rotas retornadas são otimizadas para táxis. Funcionalidade BETA.

truck

string

As rotas retornadas são otimizadas para veículos comerciais, como para caminhões.

van

string

As rotas retornadas são otimizadas para vans. Funcionalidade BETA.

VehicleEngineType

Tipo de motor do veículo. Quando um modelo de consumo detalhado é especificado, ele deve ser consistente com o valor de vehicleEngineType.

Nome Tipo Description
combustion

string

Mecanismo de combustão interna.

electric

string

Motor elétrico.

VehicleLoadType

Tipos de carga que podem ser classificadas como materiais perigosos e restritas de algumas estradas. Os valores de vehicleLoadType disponíveis são as classes Hazmat dos EUA de 1 a 9, além de classificações genéricas para uso em outros países/regiões. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto outrosHazmat devem ser usados para todos os outros países/regiões. vehicleLoadType pode ser especificado várias vezes. Atualmente, esse parâmetro é considerado apenas para travelMode=truck.

Nome Tipo Description
USHazmatClass1

string

Explosivos

USHazmatClass2

string

Gás compactado

USHazmatClass3

string

Líquidos inflamáveis

USHazmatClass4

string

Sólidos inflamáveis

USHazmatClass5

string

Oxidantes

USHazmatClass6

string

Venenos

USHazmatClass7

string

Radioativo

USHazmatClass8

string

Corrosivos

USHazmatClass9

string

Variado

otherHazmatExplosive

string

Explosivos

otherHazmatGeneral

string

Variado

otherHazmatHarmfulToWater

string

Prejudicial à água

WindingnessLevel

Nível de voltas para uma rota emocionante. Esse parâmetro só pode ser usado em conjunto com routeType=emocionante.

Nome Tipo Description
high

string

alto

low

string

baixo

normal

string

normal