Route - Post Route Range
A API de Intervalo de Rotas cria um polígono que representa a área acessível a partir de um determinado local dentro de um determinado limite com base no orçamento de tempo ou distância especificado. Um limite de polígono (ou Isochrone) é retornado em uma orientação anti-horário, bem como o centro de polígono preciso que foi o resultado do ponto de origem.
O polígono retornado pode ser usado para filtragem espacial para procurar recursos de interesse dentro da Isocrona fornecida.
Para obter informações sobre a disponibilidade de roteamento em países/regiões, consulte cobertura de roteamento do Azure Maps.
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
Cabeçalho do Pedido
Media Types: "application/geo+json"
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica a conta destinada a ser usada com o modelo de segurança Microsoft Entra ID. Essa ID exclusiva para a conta do Azure Maps pode ser obtida na API de Conta do plano de gerenciamento do Azure Maps. Para obter mais informações sobre como usar a segurança do Microsoft Entra ID no Azure Maps, consulte Gerenciar autenticação no Azure Maps. |
Corpo do Pedido
Media Types: "application/geo+json"
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| geometry | True |
Especifica o objeto Geometria de Ponto |
|
| properties | True |
Especifica os parâmetros a serem usados para o cálculo do polígono de isocrona. |
|
| type | True |
Especifica o tipo de |
Respostas
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Ocorreu um erro inesperado. Media Types: "application/geo+json", "application/json" Cabeçalhos x-ms-error-code: string |
Segurança
AADToken
Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps. - O
Authorization URLé específico para a instância de nuvem pública do Azure. As 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 a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada que é provisionada ao criar um de recursos do
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do
Tipo:
apiKey
Em:
header
Exemplos
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
Pedido de amostra
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"timeBudgetInSec": 6000
}
}
Resposta da amostra
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
5.86605,
50.9745
]
},
"properties": {
"type": "center"
}
},
{
"type": "Feature",
"bbox": [
3.62838,
49.83259,
7.9826,
52.25674
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
5.73602,
52.03704
],
[
5.59435,
52.09456
],
[
5.42279,
52.16815
],
[
5.21276,
52.25047
],
[
5.15355,
52.21374
],
[
4.96687,
52.25674
],
[
4.739,
52.07834
],
[
4.72513,
52.05647
],
[
4.53237,
51.94553
],
[
4.31165,
51.70119
],
[
4.28917,
51.5837
],
[
3.82685,
51.48463
],
[
3.62838,
51.21096
],
[
3.89244,
50.6814
],
[
3.93493,
50.66791
],
[
3.98156,
50.49042
],
[
4.47995,
50.30944
],
[
4.60502,
50.24448
],
[
4.89999,
50.24467
],
[
5.04206,
50.08735
],
[
5.23042,
49.99214
],
[
5.40994,
49.88478
],
[
5.46178,
49.85797
],
[
5.7196,
49.86279
],
[
5.74151,
49.83259
],
[
5.9387,
50.22239
],
[
6.08535,
50.0011
],
[
6.12089,
50.04616
],
[
6.28373,
50.09472
],
[
6.51654,
49.95863
],
[
6.61034,
50.00485
],
[
6.70295,
50.00587
],
[
6.65865,
50.2947
],
[
6.79276,
50.36903
],
[
7.32163,
50.31614
],
[
7.58782,
50.36737
],
[
7.7626,
50.46919
],
[
7.9826,
50.96246
],
[
7.55924,
51.07086
],
[
7.58138,
51.36614
],
[
7.67861,
51.52015
],
[
7.35175,
51.65781
],
[
7.21664,
51.81916
],
[
7.0467,
51.9587
],
[
6.67267,
51.82713
],
[
6.48424,
51.81133
],
[
6.27316,
51.9368
],
[
6.14452,
52.01701
],
[
6.09312,
52.20847
],
[
6.01297,
52.23705
],
[
5.86605,
50.9745
],
[
5.73602,
52.03704
]
]
]
},
"properties": {
"type": "boundary"
}
}
]
}
Definições
| Name | Description |
|---|---|
|
Adr |
O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas. |
|
Features |
Especifica o tipo de |
|
Feature |
Especifica o tipo de |
|
Input |
Especifica os parâmetros a serem usados para o cálculo do polígono de isocrona. |
|
Maps |
O detalhe do erro. |
|
Maps |
Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha. |
|
Maps |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
Route |
Especifica as restrições que o cálculo de rota deve respeitar ao determinar os locais alcançáveis. Evite suporta vários valores em uma solicitação. Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"] |
|
Route |
Propriedades de intervalos de rota. |
|
Route |
Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota. |
|
Route |
Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais. Exemplo: "optimizeRoute":"shortest" |
|
Route |
Especifica o objeto Geometria de Ponto |
|
Route |
Especifica o objeto |
|
Route |
Especifica o ponto de partida para o cálculo do intervalo.
|
|
Route |
Este objeto é retornado de uma chamada bem-sucedida. |
|
Route |
Especifica o perfil de viagem a ser considerado ao calcular o polígono de intervalo. Se não for especificado, o valor padrão é "condução". Exemplo: "travelMode":"driving" |
|
Route |
Os tipos de recurso para os objetos de feição retornados na resposta. |
|
Route |
Especifica os atributos do veículo, como altura, peso, velocidade máxima, tipo de carga, etc., a serem considerados ao calcular os locais alcançáveis. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo. Os atributos do veículo são especificados na propriedade vehicleSpec. |
|
Vehicle |
Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação. |
AdrTunnelRestrictionCodeEnum
O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas.
| Valor | Description |
|---|---|
| B |
Os veículos com o código B estão sujeitos a restrições nas estradas com túnel ADR das categorias B, C, D e E. |
| C |
Os veículos com o código C são restringidos nas estradas com túnel ADR das categorias C, D e E |
| D |
Os veículos com o código D são proibidos de circular nas estradas com túnel ADR das categorias D e E. |
| E |
Os veículos com o código E são proibidos de circular nas estradas com túnel ADR da categoria E. |
FeaturesItemTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica o tipo de objeto |
FeatureTypeEnum
Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.
| Valor | Description |
|---|---|
| FeatureCollection |
Especifica o tipo de objeto |
InputRouteRangeProperties
Especifica os parâmetros a serem usados para o cálculo do polígono de isocrona.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| avoid |
Especifica as restrições que o cálculo de rota deve respeitar ao determinar os locais alcançáveis. Evite suporta vários valores em uma solicitação. Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
A data e hora de partida do ponto de origem formatado como um valor dateTime definido pelo RFC 3339, seção 5.6. Quando um deslocamento de fuso horário não é especificado, UTC será assumido. Se o Exemplo: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| distanceBudgetInMeters |
number (float) minimum: 0maximum: 500000 |
O orçamento de distância especifica o alcance máximo em metros que pode ser percorrido a partir do ponto de passagem de origem. Não pode ser definido quando Quando Exemplo: "distanceBudgetInMeters":5000 |
|
| isSimplifiedPolygon |
boolean |
True |
Use isso para especificar se você precisa de polígonos simplificados que reduzam o número de vértices de polígonos, preservando a forma. A API retorna polígono de baixa definição por padrão. |
| optimizeRoute | fastestWithoutTraffic |
Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais. Exemplo: "optimizeRoute":"shortest" |
|
| timeBudgetInSec |
number (float) minimum: 0maximum: 21600 |
O orçamento de tempo especifica o tempo máximo em segundos disponível para a viagem, definindo até onde se pode ir dentro dessa restrição de tempo do ponto de passagem de origem. Não pode ser definido quando Quando Exemplo: "timeBudgetInSec":3600 |
|
| travelMode | driving |
Especifica o perfil de viagem a ser considerado ao calcular o polígono de intervalo. Se não for especificado, o valor padrão é "condução". Exemplo: "travelMode":"driving" |
|
| vehicleSpec |
Especifica os atributos do veículo, como altura, peso, velocidade máxima, tipo de carga, etc., a serem considerados ao calcular os locais alcançáveis. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo. Os atributos do veículo são especificados na propriedade vehicleSpec. |
MapsErrorDetail
O detalhe do erro.
| Name | Tipo | Description |
|---|---|---|
| code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
| details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
| message |
string |
Uma representação legível por humanos do erro. |
| target |
string |
O alvo do erro. |
MapsErrorResponse
Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha.
| Name | Tipo | Description |
|---|---|---|
| error |
O detalhe do erro. |
MapsInnerError
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
| Name | Tipo | Description |
|---|---|---|
| code |
string |
O código de erro. |
| innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
RouteRangeAvoidEnum
Especifica as restrições que o cálculo de rota deve respeitar ao determinar os locais alcançáveis. Evite suporta vários valores em uma solicitação.
Exemplo: "evitar": ["limitedAccessHighways", "tollRoads"]
| Valor | Description |
|---|---|
| limitedAccessHighways |
Evita o uso de rodovias de acesso limitado na rota. |
| tollRoads |
Evita o uso de estradas com portagem no percurso. |
| ferries |
Evita o uso de balsas na rota. |
| tunnels |
Evita o uso de túneis no percurso. |
| borderCrossings |
Evita atravessar as fronteiras do país na rota. |
| lowEmissionZones |
Evita zonas de baixas emissões na rota. |
| unpavedRoads |
Evita estradas não pavimentadas no percurso. |
| carpools |
Evita rotas que exijam o uso de carona. |
| carTrains |
Evita trens de carro. |
RouteRangeFeatureProperties
Propriedades de intervalos de rota.
| Name | Tipo | Description |
|---|---|---|
| type |
Os tipos de recurso para os objetos de feição retornados na resposta. |
RouteRangeFeaturesItem
Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.
| Name | Tipo | Description |
|---|---|---|
| bbox |
number[] (double) |
Uma área retangular na Terra definida como um objeto de caixa delimitadora. Os lados dos retângulos são definidos por valores de latitude e longitude. Para obter mais informações, consulte RFC 7946, Seção 5. Exemplo: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteRangeGeometry: |
Um objeto |
| properties |
Propriedades de intervalos de rota. |
|
| type |
Especifica o tipo de |
RouteRangeOptimizeRouteEnum
Especifica o parâmetro a ser usado para otimizar a rota. Se não estiver definido, o padrão é "fastestWithoutTraffic", que retorna a rota para minimizar o tempo de viagem sem usar as informações de tráfego atuais.
Exemplo: "optimizeRoute":"shortest"
| Valor | Description |
|---|---|
| shortest |
O percurso é calculado para minimizar a distância. As informações de tráfego não são utilizadas. |
| fastestWithoutTraffic |
Encontra a rota mais rápida, sem levar em conta as informações de trânsito. |
| fastestWithTraffic |
A rota é calculada para minimizar o tempo usando as informações de tráfego atuais.
|
RouteRangePointGeometry
Especifica o objeto Geometria de Ponto GeoJSON. Consulte RFC 7946 para obter detalhes.
RouteRangePolygonGeometry
Especifica o objeto GeoJSON Polygon Geometry (Geometria do polígono). Consulte RFC 7946 para obter detalhes.
RouteRangeRequest
Especifica o ponto de partida para o cálculo do intervalo.
GeoJSON objeto de recurso e propriedades adicionais. Consulte RFC 7946 para obter detalhes.
| Name | Tipo | Description |
|---|---|---|
| geometry |
Especifica o objeto Geometria de Ponto |
|
| properties |
Especifica os parâmetros a serem usados para o cálculo do polígono de isocrona. |
|
| type |
Especifica o tipo de |
RouteRangeResponse
Este objeto é retornado de uma chamada bem-sucedida.
| Name | Tipo | Description |
|---|---|---|
| features |
|
|
| type |
Especifica o tipo de |
RouteRangeTravelModeEnum
Especifica o perfil de viagem a ser considerado ao calcular o polígono de intervalo. Se não for especificado, o valor padrão é "condução".
Exemplo: "travelMode":"driving"
| Valor | Description |
|---|---|
| driving |
Perfil de roteamento adequado para carros são usados para o cálculo de polígonos de alcance. |
| truck |
O perfil de roteamento adequado para veículos comerciais, como caminhões, é usado para o cálculo de polígonos de autonomia. |
RouteRangeTypeEnum
Os tipos de recurso para os objetos de feição retornados na resposta.
| Valor | Description |
|---|---|
| center |
O tipo de recurso de ponto central representa o ponto usado para o cálculo do polígono de intervalo. |
| boundary |
O tipo de recurso de limite representa o polígono de intervalo. |
RouteRangeVehicleSpec
Especifica os atributos do veículo, como altura, peso, velocidade máxima, tipo de carga, etc., a serem considerados ao calcular os locais alcançáveis. Isso ajuda a evitar baixas folgas de pontes, restrições de estrada, curvas difíceis à direita para fornecer a rota otimizada do caminhão com base nas especificações do veículo. Os atributos do veículo são especificados na propriedade vehicleSpec.
| Name | Tipo | Default value | Description |
|---|---|---|---|
| adrTunnelRestrictionCode |
O código de restrição do túnel ADR. O ADR é um acordo europeu relativo ao transporte rodoviário internacional de mercadorias perigosas. O código de restrição do túnel ADR é utilizado para determinar se um veículo pode atravessar um túnel com restrições ao transporte de mercadorias perigosas. |
||
| axleCount |
integer (int64) |
O número de eixos do veículo. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso por eixo do veículo, em kg. Um valor 0 significa que as restrições de peso por eixo não são consideradas. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Altura do veículo em metros. Um valor 0 significa que as restrições de altura não são consideradas. |
| isVehicleCommercial |
boolean |
False |
Se o veículo é utilizado para fins comerciais. Os veículos comerciais podem não ser autorizados a circular em algumas estradas. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Comprimento do veículo em metros. Um valor de 0 significa que as restrições de comprimento não são consideradas. |
| loadType |
Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Velocidade máxima do veículo em km/hora. A velocidade máxima no perfil do veículo é utilizada para verificar se um veículo é permitido em autoestradas. Um valor 0 significa que será determinado e aplicado um valor adequado para o veículo durante o planeamento de rotas. Um valor diferente de zero pode ser substituído durante o planejamento de rotas. Por exemplo, o fluxo de tráfego atual é de 60 km/hora. Se a velocidade máxima do veículo estiver definida para 50 km/hora, o motor de encaminhamento considerará 60 km/hora, uma vez que esta é 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 motor de roteamento usará novamente 60 km/hora. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso do veículo em quilogramas. Um valor 0 significa que as restrições de peso não são consideradas. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Largura do veículo em metros. Um valor de 0 significa que as restrições de largura não são consideradas. |
VehicleLoadTypeEnum
Tipos de carga que podem ser classificados como materiais perigosos e restringidos a partir de algumas estradas. Os valores disponíveis de vehicleLoadType são as classes 1 a 9 do Hazmat dos EUA, além de classificações genéricas para uso em outros países. Os valores que começam com USHazmat são para roteamento dos EUA, enquanto otherHazmat deve ser usado para todos os outros países. vehicleLoadType suporta vários valores em uma solicitação.
| Valor | Description |
|---|---|
| USHazmatClass1 |
Explosivos |
| USHazmatClass2 |
Gás comprimido |
| USHazmatClass3 |
Líquidos inflamáveis |
| USHazmatClass4 |
Sólidos inflamáveis |
| USHazmatClass5 |
Oxidantes |
| USHazmatClass6 |
Venenos |
| USHazmatClass7 |
Radioativo |
| USHazmatClass8 |
Corrosivos |
| USHazmatClass9 |
Diversos |
| otherHazmatExplosive |
Explosivos |
| otherHazmatGeneral |
Diversos |
| otherHazmatHarmfulToWater |
Nocivo para a água |