Route - Post Route Range
La API de intervalo de rutas crea un polígono que muestra el área accesible desde una ubicación determinada dentro de un umbral determinado en función del presupuesto de tiempo o distancia especificados. Se devuelve un límite de polígono (o Isochrone) en una orientación en sentido contrario a las agujas del reloj, así como el centro de polígono preciso que era el resultado del punto de origen.
El polígono devuelto se puede usar para el filtrado espacial para buscar características de interés en el Isochrone proporcionado.
Para información sobre la disponibilidad de rutas en países/regiones, véase Azure Maps cobertura de enrutamiento.
POST https://atlas.microsoft.com/route/range?api-version=2025-01-01
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número de versión de Azure Maps API. |
Encabezado de la solicitud
Media Types: "application/geo+json"
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
Cuerpo de la solicitud
Media Types: "application/geo+json"
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| geometry | True |
Especifica el objeto geometry de punto |
|
| properties | True |
Especifica los parámetros que se van a usar para el cálculo del polígono isochrone. |
|
| type | True |
Especifica el tipo de |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
OK Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Error inesperado. Media Types: "application/geo+json", "application/json" Encabezados x-ms-error-code: string |
Seguridad
AADToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para las APIs REST de Azure Maps.
Para implementar escenarios, se recomienda ver conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Nota:
- Esta definición de seguridad requiere el uso del encabezado
x-ms-client-idpara indicar a qué Azure Maps recurso solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. - El control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, Azure SDKs o APIs REST.
- El uso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Esta es una clave compartida que se provisiona al crear un recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, Azure SDKs o APIs REST.
Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.
Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el acceso servidor a servidor de las APIs REST de Azure Maps, donde esta clave pueda almacenarse de forma segura.
Tipo:
apiKey
En:
header
SAS Token
Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión Azure mediante portal Azure, PowerShell, CLI, Azure SDKs o APIs REST.
Con este token, cualquier aplicación está autorizada para acceder mediante Azure a controles de acceso basados en roles y a un control minucioso de la expiración, tasa y región(es) de uso para el token en particular. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Successfully retrieve a set of locations that can be reached from the origin point based on the specified conditions
Solicitud de ejemplo
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
}
}
Respuesta de muestra
{
"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"
}
}
]
}
Definiciones
| Nombre | Description |
|---|---|
|
Adr |
Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas. |
|
Features |
Especifica el tipo de |
|
Feature |
Especifica el tipo de |
|
Input |
Especifica los parámetros que se van a usar para el cálculo del polígono isochrone. |
|
Maps |
Detalle del error. |
|
Maps |
Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas. |
|
Maps |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
Route |
Especifica las restricciones que debe respetar el cálculo de la ruta al determinar las ubicaciones accesibles. Evite admitir varios valores en una solicitud. Ejemplo: "avoid": ["limitedAccessHighways", "tollRoads"] |
|
Route |
Propiedades de intervalos de ruta. |
|
Route |
Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta. |
|
Route |
Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual. Ejemplo: "optimizeRoute":"shortest" |
|
Route |
Especifica el objeto geometry de punto |
|
Route |
Especifica el |
|
Route |
Especifica el punto de partida para el cálculo del intervalo.
|
|
Route |
Este objeto se devuelve de una llamada correcta. |
|
Route |
Especifica el perfil de viaje que se debe tener en cuenta al calcular el polígono de intervalo. Si no se especifica, el valor predeterminado es "driving". Ejemplo: "travelMode":"driving" |
|
Route |
Los tipos de características de los objetos de característica devueltos en la respuesta. |
|
Route |
Especifica los atributos del vehículo, como la altura del vehículo, el peso, la velocidad máxima, el tipo de carga, etc. que se deben tener en cuenta al calcular las ubicaciones accesibles. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo. Los atributos del vehículo se especifican dentro de la propiedad vehicleSpec. |
|
Vehicle |
Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud. |
AdrTunnelRestrictionCodeEnum
Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.
| Valor | Description |
|---|---|
| B |
Los vehículos con código B están restringidos de carreteras con categorías de túnel ADR B, C, D y E. |
| C |
Los vehículos con código C están restringidos de carreteras con categorías de túnel ADR C, D y E |
| D |
Los vehículos con código D están restringidos a las carreteras con categorías de túnel ADR D y E. |
| E |
Los vehículos con código E están restringidos a las carreteras con la categoría de túnel ADR E. |
FeaturesItemTypeEnum
Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.
| Valor | Description |
|---|---|
| Feature |
Especifica el tipo de objeto feature de |
FeatureTypeEnum
Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.
| Valor | Description |
|---|---|
| FeatureCollection |
Especifica el tipo de objeto |
InputRouteRangeProperties
Especifica los parámetros que se van a usar para el cálculo del polígono isochrone.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| avoid |
Especifica las restricciones que debe respetar el cálculo de la ruta al determinar las ubicaciones accesibles. Evite admitir varios valores en una solicitud. Ejemplo: "avoid": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Fecha y hora de salida del punto de origen con formato de valor dateTime definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se asume la hora UTC. Si no se establece el Ejemplo: "salida": "2023-06-01T09:30:00.000-07:00" |
|
| distanceBudgetInMeters |
number (float) minimum: 0maximum: 500000 |
El presupuesto de distancia especifica el intervalo máximo en metros que se pueden desplazar desde el punto de acceso de origen. No se puede establecer cuando se especifica Cuando Ejemplo: "distanceBudgetInMeters":5000 |
|
| isSimplifiedPolygon |
boolean |
True |
Úselo para especificar si necesita polígonos simplificados que reduzcan el número de vértices de polígono al tiempo que conservan la forma. La API devuelve un polígono de baja definición de forma predeterminada. |
| optimizeRoute | fastestWithoutTraffic |
Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual. Ejemplo: "optimizeRoute":"shortest" |
|
| timeBudgetInSec |
number (float) minimum: 0maximum: 21600 |
El presupuesto de tiempo especifica el tiempo máximo en segundos disponible para el viaje, definiendo la distancia que puede ir dentro de esta restricción de tiempo desde el punto de acceso de origen. No se puede establecer cuando se especifica Cuando Ejemplo: "timeBudgetInSec":3600 |
|
| travelMode | driving |
Especifica el perfil de viaje que se debe tener en cuenta al calcular el polígono de intervalo. Si no se especifica, el valor predeterminado es "driving". Ejemplo: "travelMode":"driving" |
|
| vehicleSpec |
Especifica los atributos del vehículo, como la altura del vehículo, el peso, la velocidad máxima, el tipo de carga, etc. que se deben tener en cuenta al calcular las ubicaciones accesibles. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo. Los atributos del vehículo se especifican dentro de la propiedad vehicleSpec. |
MapsErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
| message |
string |
Una representación en lenguaje natural del error. |
| target |
string |
Destino del error. |
MapsErrorResponse
Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Detalle del error. |
MapsInnerError
Objeto que contiene información más específica que el objeto actual sobre el error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Código de error. |
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
RouteRangeAvoidEnum
Especifica las restricciones que debe respetar el cálculo de la ruta al determinar las ubicaciones accesibles. Evite admitir varios valores en una solicitud.
Ejemplo: "avoid": ["limitedAccessHighways", "tollRoads"]
| Valor | Description |
|---|---|
| limitedAccessHighways |
Evita el uso de autopistas de acceso limitado en la ruta. |
| tollRoads |
Evita el uso de carreteras de peaje en la ruta. |
| ferries |
Evita el uso de ferris en la ruta. |
| tunnels |
Evita el uso de túneles en la ruta. |
| borderCrossings |
Evita cruzar las fronteras del país en la ruta. |
| lowEmissionZones |
Evita zonas de baja emisión en la ruta. |
| unpavedRoads |
Evita carreteras sin pintar en la ruta. |
| carpools |
Evita las rutas que requieren el uso de carpool. |
| carTrains |
Evita trenes de coches. |
RouteRangeFeatureProperties
Propiedades de intervalos de ruta.
| Nombre | Tipo | Description |
|---|---|---|
| type |
Los tipos de características de los objetos de característica devueltos en la respuesta. |
RouteRangeFeaturesItem
Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.
| Nombre | Tipo | Description |
|---|---|---|
| bbox |
number[] (double) |
Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de latitud y longitud. Para obtener más información, vea RFC 7946, Sección 5. Ejemplo: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteRangeGeometry: |
Objeto Geometry válido |
| properties |
Propiedades de intervalos de ruta. |
|
| type |
Especifica el tipo de |
RouteRangeOptimizeRouteEnum
Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual.
Ejemplo: "optimizeRoute":"shortest"
| Valor | Description |
|---|---|
| shortest |
La ruta se calcula para minimizar la distancia. No se usa la información de tráfico. |
| fastestWithoutTraffic |
Busca la ruta más rápida, sin factorizar la información de tráfico. |
| fastestWithTraffic |
La ruta se calcula para minimizar el tiempo mediante la información de tráfico actual.
|
RouteRangePointGeometry
Especifica el objeto geometry de punto GeoJSON. Consulte RFC 7946 para obtener más información.
RouteRangePolygonGeometry
Especifica el GeoJSON objeto Geometry polygon. Consulte RFC 7946 para obtener más información.
RouteRangeRequest
Especifica el punto de partida para el cálculo del intervalo.
GeoJSON objeto de característica y propiedades adicionales. Consulte RFC 7946 para obtener más información.
| Nombre | Tipo | Description |
|---|---|---|
| geometry |
Especifica el objeto geometry de punto |
|
| properties |
Especifica los parámetros que se van a usar para el cálculo del polígono isochrone. |
|
| type |
Especifica el tipo de |
RouteRangeResponse
Este objeto se devuelve de una llamada correcta.
| Nombre | Tipo | Description |
|---|---|---|
| features |
|
|
| type |
Especifica el tipo de |
RouteRangeTravelModeEnum
Especifica el perfil de viaje que se debe tener en cuenta al calcular el polígono de intervalo. Si no se especifica, el valor predeterminado es "driving".
Ejemplo: "travelMode":"driving"
| Valor | Description |
|---|---|
| driving |
El perfil de enrutamiento adecuado para los coches se usa para el cálculo del polígono de rango. |
| truck |
El perfil de enrutamiento adecuado para vehículos comerciales como camiones se usa para el cálculo de polígonos de rango. |
RouteRangeTypeEnum
Los tipos de características de los objetos de característica devueltos en la respuesta.
| Valor | Description |
|---|---|
| center |
El tipo de característica de punto central representa el punto utilizado para el cálculo del polígono de intervalo. |
| boundary |
El tipo de característica de límite representa el polígono de intervalo. |
RouteRangeVehicleSpec
Especifica los atributos del vehículo, como la altura del vehículo, el peso, la velocidad máxima, el tipo de carga, etc. que se deben tener en cuenta al calcular las ubicaciones accesibles. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo. Los atributos del vehículo se especifican dentro de la propiedad vehicleSpec.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| adrTunnelRestrictionCode |
Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas. |
||
| axleCount |
integer (int64) |
Número de ejes del vehículo. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso por eje del vehículo en kg. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso por eje. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura. |
| isVehicleCommercial |
boolean |
False |
Si el vehículo se utiliza para fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud. |
| loadType |
Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas. Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante el planeamiento de rutas. Un valor distinto de cero se puede invalidar durante el planeamiento de rutas. Por ejemplo, el flujo de tráfico actual es de 60 km/hora. Si la velocidad máxima del vehículo se establece en 50 km/hora, el motor de enrutamiento considerará 60 km/hora, ya que esta es la situación actual. Si la velocidad máxima del vehículo se proporciona como 80 km/hora, pero el flujo de tráfico actual es de 60 km/hora, el motor de enrutamiento volverá a usar 60 km/hora. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Peso del vehículo en kilogramos. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho. |
VehicleLoadTypeEnum
Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud.
| Valor | Description |
|---|---|
| USHazmatClass1 |
Explosivos |
| USHazmatClass2 |
Gas comprimido |
| USHazmatClass3 |
Líquidos inflamables |
| USHazmatClass4 |
Sólidos inflamables |
| USHazmatClass5 |
Oxidantes |
| USHazmatClass6 |
Venenos |
| USHazmatClass7 |
Radiactivo |
| USHazmatClass8 |
Corrosivos |
| USHazmatClass9 |
Varios |
| otherHazmatExplosive |
Explosivos |
| otherHazmatGeneral |
Varios |
| otherHazmatHarmfulToWater |
Perjudicial para el agua |