Compartir a través de


Route - Post Route Directions

Use para calcular una ruta entre un origen y un destino determinados, pasando por los puntos de referencia especificados.

La API de Post Route Directions es una solicitud de POST HTTP que devuelve una ruta entre un origen y un destino, pasando por puntos de acceso si se especifican. La ruta tendrá en cuenta factores como el tráfico actual y las velocidades típicas de la carretera en el día solicitado de la semana y la hora del día.

La información devuelta incluye la distancia, el tiempo de desplazamiento estimado y una representación de la geometría de ruta. También hay disponible información de enrutamiento adicional, como el orden optimizado del punto de acceso o las instrucciones de turno por turno, en función de las opciones seleccionadas.

El servicio de enrutamiento proporciona un conjunto de parámetros para una descripción detallada de un modelo de consumo específico del vehículo. Consulte modelo de consumo para obtener una explicación detallada de los conceptos y parámetros implicados.

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 identificador URI

Nombre En Requerido Tipo Description
format
path True

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

api-version
query True

string

Número de versión de la API de Azure Maps.

query
query True

string

Coordenadas a través de las que se calcula la ruta, delimitada por dos puntos. Se requiere un mínimo de dos coordenadas. La primera es el origen y la última es el destino de la ruta. Las coordenadas opcionales entre actúan como WayPoints en la ruta. Puede pasar hasta 150 WayPoints.

accelerationEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía cinética cuando el vehículo acelera (es decir, CinéticaEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con deceleraciónEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/deceleraciónEfficiency.

Valores razonables: para modelo de combustión : 0,33, para modelo eléctrico : 0,66

alternativeType
query

AlternativeRouteType

Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.

arriveAt
query

string

date-time

La fecha y hora de llegada al punto de destino con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento de zona horaria opcional. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de destino.

Ejemplos:

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

El parámetro arriveAt no se puede usar junto con departAt, minDeviationDistance o minDeviationTime.

auxiliaryPowerInkW
query

number

double

Especifica la cantidad de energía consumida para mantener sistemas auxiliares, en kilowatts (kW).

Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etc.

Valores razonables: 1,7

auxiliaryPowerInLitersPerHour
query

number

double

Especifica la cantidad de combustible consumido para mantener sistemas auxiliares del vehículo, en litros por hora.

Se puede utilizar para especificar el consumo debido a dispositivos y sistemas como sistemas de CA, radio, calefacción, etc.

Valores razonables: 0,2

avoid
query

RouteAvoidType[]

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.

computeBestOrder
query

boolean

Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir la longitud de la ruta. Produce mejores resultados cuando se usa junto con routeType más corto. Observe que el origen y el destino se excluyen de los índices de punto de referencia optimizados. Para incluir el origen y el destino en la respuesta, aumente todos los índices en 1 para tener en cuenta el origen y agregue el destino como índice final. Los valores posibles son true o false. True calcula un orden mejor si es posible, pero no se permite usar junto con el valor maxAlternatives mayor que 0 o junto con los puntos de referencia de círculo. False usará las ubicaciones en el orden especificado y no podrá usarse junto con routeRepresentation ninguno.

computeTravelTimeFor
query

ComputeTravelTime

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.

constantSpeedConsumptionInkWhPerHundredkm
query

string

Especifica el componente dependiente de la velocidad del consumo.

Se proporciona como una lista desordenada de pares de velocidad/velocidad de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera:

  • por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista

  • por extrapolación lineal en caso contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista

La lista debe contener entre 1 y 25 puntos (inclusive) y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional.

El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas.

Del mismo modo, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad más pequeña.

El intervalo válido para los valores de consumo (expresados en kWh/100km) está comprendido entre 0,01 y 100000,0.

Valores razonables: 50,8.2:130,21.3

Este parámetro es necesario para modelo de consumo eléctrico.

constantSpeedConsumptionInLitersPerHundredkm
query

string

Especifica el componente dependiente de la velocidad del consumo.

Se proporciona como una lista desordenada de velocidad delimitada por dos puntos & pares de tasa de consumo. La lista define puntos en una curva de consumo. Las tasas de consumo de velocidades que no están en la lista se encuentran de la siguiente manera:

  • por interpolación lineal, si la velocidad dada se encuentra entre dos velocidades de la lista

  • por extrapolación lineal en caso contrario, suponiendo una constante (ΔConsumption/ΔSpeed) determinada por los dos puntos más cercanos de la lista

La lista debe contener entre 1 y 25 puntos (inclusive) y puede que no contenga puntos duplicados para la misma velocidad. Si solo contiene un único punto, la tasa de consumo de ese punto se usa sin procesamiento adicional.

El consumo especificado para la mayor velocidad debe ser mayor o igual que el de la penúltima velocidad más grande. Esto garantiza que la extrapolación no conduce a tasas de consumo negativas.

Del mismo modo, los valores de consumo especificados para las dos velocidades más pequeñas de la lista no pueden dar lugar a una tasa de consumo negativa para cualquier velocidad más pequeña.

El intervalo válido para los valores de consumo (expresados en l/100km) está comprendido entre 0,01 y 100000,0.

Valores razonables: 50,6.3:130,11.5

Nota : este parámetro es necesario para el modelo de consumo de combustión.

currentChargeInkWh
query

number

double

Especifica el suministro de energía eléctrica actual en horas de kilowatt (kWh).

Este parámetro coexiste con parámetro maxChargeInkWh.

El intervalo de valores permitidos es de 0,0 a maxChargeInkWh.

Valores razonables: 43

currentFuelInLiters
query

number

double

Especifica el suministro actual de combustible en litros.

Valores razonables: 55

decelerationEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía cinética a combustible ahorrado (no consumido) cuando el vehículo se decelera (es decir, ChemicalEnergySaved/CinéticaEnergyLost). El ChemicalEnergySaved se obtiene convirtiendo el combustible ahorrado (no consumido) a energía utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con aceleraciónEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/aceleraciónEfficiency.

Valores razonables: para modelo de combustión : 0,83, para modelo eléctrico : 0,91

departAt
query

string

date-time

Fecha y hora de salida del punto de origen con formato de dateTime valor tal como se define en RFC 3339, sección 5.6, con un desplazamiento opcional de zona horaria. Cuando no se especifica un desplazamiento de zona horaria, se supone que es el del punto de origen.

  • Valor predeterminado: ahora
  • Otro valor: dateTime

Ejemplos:

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

No se puede usar el parámetro departAt junto con arriveAt.

downhillEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía potencial a combustible ahorrado (no consumido) cuando el vehículo pierde la elevación (es decir, ChemicalEnergySaved/PotentialEnergyLost). El ChemicalEnergySaved se obtiene convirtiendo el combustible ahorrado (no consumido) a energía utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con uphillEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/uphillEfficiency.

Valores razonables: para modelo de combustión : 0,51, para modelo eléctrico : 0,73

fuelEnergyDensityInMJoulesPerLiter
query

number

double

Especifica la cantidad de energía química almacenada en un litros de combustible en megajoules (MJ). Se utiliza junto con los parámetros *Eficiencia para conversiones entre energía guardada o consumida y combustible. Por ejemplo, la densidad de energía es 34,2 MJ/l para gasolina y 35,8 MJ/l para combustible Diesel.

Este parámetro es necesario si se establece cualquier parámetro *Efficiency.

Valores razonables: 34.2

hilliness
query

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.

instructionsType
query

RouteInstructionsType

Si se especifica, se devolverán instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none.

language
query

string

El parámetro language determina el idioma de los mensajes de guía. No afecta a los nombres adecuados (los nombres de las calles, plazas, etc.) No tiene ningún efecto cuando instructionsType=coded. Los valores permitidos son (un subconjunto de) las etiquetas de lenguaje IETF descritas.

maxAlternatives
query

integer

Número de rutas alternativas deseadas que se van a calcular. Valor predeterminado: 0, mínimo: 0 y máximo: 5

maxChargeInkWh
query

number

double

Especifica el suministro máximo de energía eléctrica en kilowatt hours (kWh) que se puede almacenar en la batería del vehículo.

Este parámetro coexiste con parámetro currentChargeInkWh.

El valor mínimo debe ser mayor o igual que currentChargeInkWh.

Valores razonables: 85

minDeviationDistance
query

integer

Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute para al menos este número de metros. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationDistance no se puede usar junto con arriveAt

minDeviationTime
query

integer

Todas las rutas alternativas devueltas seguirán la ruta de referencia (consulte la sección Solicitudes POST) desde el punto de origen de la solicitud calculateRoute durante al menos este número de segundos. Solo se puede usar al reconstruir una ruta. El parámetro minDeviationTime no se puede usar junto con arriveAt. El valor predeterminado es 0. Establecer )minDeviationTime_ en un valor mayor que cero tiene las siguientes consecuencias:

  • El punto de origen del calculateRoute Request debe estar en la ruta de referencia de entrada (o muy cerca).
    • Si no es así, se devuelve un error.
    • Sin embargo, el punto de origen no necesita estar al principio de la ruta de referencia de entrada (se puede considerar como la posición actual del vehículo en la ruta de referencia).
  • La ruta de referencia, que se devuelve como la primera ruta de la calculateRoute Response, se iniciará en el punto de origen especificado en el calculateRoute Request. Parte inicial de la ruta de referencia de entrada hasta que el punto de origen se excluirá de la respuesta.
  • Los valores de minDeviationDistance y minDeviationTime determinar hasta dónde se garantizarán las rutas alternativas para seguir la ruta de referencia desde el punto de origen en adelante.
  • La ruta debe usar departAt.
  • Se omite el de vehicleHeading.
report
query

Report

Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.

routeRepresentation
query

RouteRepresentationForBestOrder

Especifica la representación del conjunto de rutas proporcionadas como respuesta.

routeType
query

RouteType

Tipo de ruta solicitada.

sectionType
query

SectionType[]

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche

traffic
query

boolean

Valores posibles:

  • true: considere toda la información de tráfico disponible durante el enrutamiento.
  • false: omite los datos de tráfico actuales durante el enrutamiento. Tenga en cuenta que, aunque los datos de tráfico actuales se omiten durante el enrutamiento, el efecto del tráfico histórico en velocidades de carretera efectivas todavía se incorpora.
travelMode
query

TravelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

uphillEfficiency
query

number

double

Especifica la eficiencia de la conversión de energía química almacenada en combustible a energía potencial cuando el vehículo obtiene la elevación (es decir, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed se obtiene convirtiendo el combustible consumido en energía química utilizando fuelEnergyDensityInMJoulesPerLiter.

Debe emparejarse con downhillEfficiency.

El intervalo de valores permitidos es de 0,0 a 1/downhillEfficiency.

Valores razonables: para modelo de combustión : 0,27 para modelo eléctrico : 0,74

vehicleAxleWeight
query

integer

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.

vehicleCommercial
query

boolean

Si el vehículo se utiliza para fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.

vehicleEngineType
query

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

vehicleHeading
query

integer

El encabezado direccional del vehículo en grados comenzando en el verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados. Valores posibles entre 0 y 359

vehicleHeight
query

number

double

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.

vehicleLength
query

number

double

Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.

vehicleLoadType
query

VehicleLoadType

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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

vehicleMaxSpeed
query

integer

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.

vehicleWeight
query

integer

Peso del vehículo en kilogramos.

  • Es obligatorio si se establece cualquiera de los parámetros *Efficiency.

  • Debe ser estrictamente positivo cuando se usa en el contexto del modelo de consumo. Se consideran restricciones de peso.

  • Si no se especifica ningún modelo de consumo detallado y el valor de vehicleWeight es distinto de cero, se tienen en cuenta las restricciones de peso.

  • En todos los demás casos, este parámetro se omite.

Valores razonables: para modelo de combustión : 1600, para modelo eléctrico : 1900

vehicleWidth
query

number

double

Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.

windingness
query

WindingnessLevel

Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Microsoft Entra. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad del identificador de Entra de Microsoft en Azure Maps, consulte los siguientes artículos de para obtener instrucciones.

Cuerpo de la solicitud

Nombre Tipo Description
allowVignette

string[]

Se trata de una lista de códigos de país iso 3166-1, alfa-3 de países o regiones en los que se permiten carreteras de peaje con viñetas, por ejemplo, "AUS,CHE". Especificar allowVignette con algunos países o regiones X equivale a especificar evitarVignette con todos los países o regiones, pero X. Especificar allowVignette con una lista vacía es el mismo que evitar todas las carreteras de peaje con viñetas. Nota: Se trata de un error especificar tanto evitarVignette y allowVignette.

avoidAreas

GeoJsonMultiPolygon

GeoJSON MultiPolygon que representa la lista de áreas que se van a evitar. Solo se admiten polígonos de rectángulo. El tamaño máximo de un rectángulo es de aproximadamente 160x160 km. El número máximo de áreas evitadas es 10. No puede cruzar el meridiano 180. Debe estar entre -80 y +80 grados de latitud.

avoidVignette

string[]

Esta es una lista de códigos de país de 3 caracteres, ISO 3166-1, alfa-3 de países o regiones en los que se deben evitar todas las carreteras de peaje con viñetas, por ejemplo, "AUS,CHE". Las carreteras de peaje con viñetas en países o regiones que no están en la lista no se ven afectadas. Nota: Se trata de un error especificar tanto evitarVignette y allowVignette.

supportingPoints

GeoJsonGeometryCollection

Colección de geometría GeoJSON que representa la secuencia de coordenadas usadas como entrada para la reconstrucción de rutas y para calcular cero o más rutas alternativas a esta ruta de referencia.

  • La secuencia proporcionada de puntos auxiliares se usa como entrada para la reconstrucción de rutas.
  • Las rutas alternativas se calculan entre los puntos de origen y destino especificados en las ubicaciones de parámetros de ruta de acceso base.
  • Si tanto minDeviationDistance y minDeviationTime se establecen en cero, se espera que estos puntos de origen y destino estén en (o muy cerca) el principio y el final de la ruta de referencia, respectivamente.
  • No se admiten ubicaciones intermedias (puntos de acceso) al usar <admitePoints>.
  • La ruta de referencia puede contener incidentes de tráfico de tipo ROAD_CLOSURE, que se omiten para el cálculo del tiempo de desplazamiento y el retraso del tráfico de la ruta de referencia. Consulte de puntos auxiliares para obtener más información.

Respuestas

Nombre Tipo Description
200 OK

RouteDirections

De acuerdo

Other Status Codes

ErrorResponse

Error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API 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.

Notas

  • Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

El Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso de sdk web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

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

Se trata de una clave compartida que se aprovisiona al Creación de una cuenta de Azure Maps en Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

Para las aplicaciones expuestas públicamente, nuestra recomendación es usar las aplicaciones cliente confidenciales enfoque acceder a las API REST de Azure Maps para que la clave se pueda almacenar de forma segura.

Tipo: apiKey
En: query

SAS Token

Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. 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 route between an origin and a destination with additional parameters in the body

Solicitud de ejemplo

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
          ]
        ]
      ]
    ]
  }
}

Respuesta de muestra

{
  "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"
        }
      ]
    }
  ]
}

Definiciones

Nombre Description
AlternativeRouteType

Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.

ComputeTravelTime

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.

DelayMagnitude

Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta del Get Traffic Incident Detail API.

DrivingSide

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.

EffectiveSetting

Parámetro o datos efectivos que se usan al llamar a esta ROUTE API.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

GeoJsonGeometry

Un objeto geometry válido GeoJSON. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

GeoJsonGeometryCollection

Tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obtener más información.

GeoJsonLineString

Un tipo de geometría GeoJSON LineString válido. Consulte RFC 7946 para obtener más información.

GeoJsonMultiLineString

Un tipo de geometría GeoJSON MultiLineString válido. Consulte RFC 7946 para obtener más información.

GeoJsonMultiPoint

Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

GeoJsonMultiPolygon

Tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obtener más información.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

GeoJsonPolygon

Un tipo de geometría GeoJSON Polygon válido. Consulte RFC 7946 para obtener más información.

GuidanceInstructionType

Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.

GuidanceManeuver

Código que identifica la maniobra.

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.

JunctionType

Tipo de unión donde se realiza la maniobra. Para los redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.

LatLongPair

Ubicación representada como latitud y longitud.

Report

Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada

ResponseTravelMode

Modo de desplazamiento para la ruta calculada. El valor se establecerá en other si el modo de transporte solicitado no es posible en esta sección.

Route
RouteAvoidType

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.

RouteDirectionParameters

Publique los parámetros del cuerpo para las direcciones de ruta.

RouteDirections

Este objeto se devuelve de una llamada a Route Directions correcta.

RouteGuidance

Contiene elementos relacionados con instrucciones. Este campo solo está presente cuando se solicitó la guía y está disponible.

RouteInstruction

Un conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar".

RouteInstructionGroup

Agrupa una secuencia de elementos de instrucción que se relacionan entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible.

RouteInstructionsType

Si se especifica, se devolverán instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none.

RouteLeg

Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de acceso adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta.

RouteLegSummary

Objeto de resumen para la sección de ruta.

RouteOptimizedWaypoint

Objeto de punto de forma optimizado.

RouteReport

Informa de la configuración efectiva que se usa en la llamada actual.

RouteRepresentationForBestOrder

Especifica la representación del conjunto de rutas proporcionadas como respuesta.

RouteSection

Las secciones de ruta contienen información adicional sobre las partes de una ruta. Cada sección contiene al menos los elementos startPointIndex, endPointIndexy sectionType.

RouteSectionTec

Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC de . Puede contener effectCode y provoca elementos.

RouteSectionTecCause

Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones.

RouteSummary

Summary (objeto)

RouteType

Tipo de ruta solicitada.

SectionType

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche

SimpleCategory

Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTROS. Consulte "tec" para obtener información detallada.

TravelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

VehicleLoadType

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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

WindingnessLevel

Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

AlternativeRouteType

Controla la óptimaidad, con respecto a los criterios de planificación especificados, de las alternativas calculadas en comparación con la ruta de referencia.

Nombre Tipo Description
anyRoute

string

Permitir que se devuelva cualquier ruta alternativa independientemente de cómo se compare con la ruta de referencia en términos de óptimaidad.

betterRoute

string

Devolver una ruta alternativa solo si es mejor que la ruta de referencia según los criterios de planificación especificados.

ComputeTravelTime

Especifica si se devuelven tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico (ninguno, histórico, activo), así como el tiempo de desplazamiento predeterminado de mejor estimación.

Nombre Tipo Description
all

string

Calcula los tiempos de desplazamiento de todos los tipos de información de tráfico y especifica todos los resultados en los campos noTrafficAdvisorTimeInSeconds, historicTrafficAdvisorTimeInSeconds y liveTrafficIncidentsEventTimeInSeconds que se incluyen en los resúmenes de la respuesta de ruta.

none

string

No calcula tiempos de desplazamiento adicionales.

DelayMagnitude

Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta del Get Traffic Incident Detail API.

Nombre Tipo Description
0

string

Desconocido.

1

string

Menor.

2

string

Moderado.

3

string

Destacado.

4

string

No definido, utilizado para cierres de carreteras y otros retrasos indefinidos.

DrivingSide

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.

Nombre Tipo Description
LEFT

string

Izquierda.

RIGHT

string

Derecho.

EffectiveSetting

Parámetro o datos efectivos que se usan al llamar a esta ROUTE API.

Nombre Tipo Description
key

string

Nombre del parámetro usado.

value

string

Valor del parámetro usado.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

GeoJsonGeometry

Un objeto geometry válido GeoJSON. El tipo debe ser uno de los siete tipos de geometría GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon y GeometryCollection. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
type

GeoJsonObjectType

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonGeometryCollection

Tipo de objeto GeoJSON GeometryCollection válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
geometries GeoJsonGeometry[]:

Contiene una lista de objetos de geometría de GeoJSON válidos. Nota que las coordenadas de GeoJSON están en x, y order (longitud, latitud).

type string:

GeometryCollection

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonLineString

Un tipo de geometría GeoJSON LineString válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la geometría GeoJson LineString.

type string:

LineString

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiLineString

Un tipo de geometría GeoJSON MultiLineString válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la geometría GeoJson MultiLineString.

type string:

MultiLineString

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPoint

Un tipo de geometría GeoJSON MultiPoint válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas de la geometría GeoJson MultiPoint.

type string:

MultiPoint

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonMultiPolygon

Tipo de objeto GeoJSON MultiPolygon válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Contiene una lista de objetos GeoJSON Polygon válidos. Nota que las coordenadas de GeoJSON están en x, y order (longitud, latitud).

type string:

MultiPolygon

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.

type string:

Point

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GeoJsonPolygon

Un tipo de geometría GeoJSON Polygon válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[]

Coordenadas del tipo de geometría GeoJson Polygon.

type string:

Polygon

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

GuidanceInstructionType

Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.

Nombre Tipo Description
DIRECTION_INFO

string

Información de dirección.

LOCATION_ARRIVAL

string

Ubicación de llegada.

LOCATION_DEPARTURE

string

Ubicación de salida.

LOCATION_WAYPOINT

string

Ubicación del punto de acceso.

ROAD_CHANGE

string

Cambio de carretera.

TURN

string

Giro.

GuidanceManeuver

Código que identifica la maniobra.

Nombre Tipo Description
ARRIVE

string

Has llegado.

ARRIVE_LEFT

string

Has llegado. El destino está a la izquierda.

ARRIVE_RIGHT

string

Has llegado. El destino está a la derecha.

BEAR_LEFT

string

Oso a la izquierda.

BEAR_RIGHT

string

Oso a la derecha.

DEPART

string

Salir.

ENTER_FREEWAY

string

Tome la autopista.

ENTER_HIGHWAY

string

Tome la carretera.

ENTER_MOTORWAY

string

Tome la autopista.

ENTRANCE_RAMP

string

Toma la rampa.

FOLLOW

string

Seguir.

KEEP_LEFT

string

Mantente a la izquierda.

KEEP_RIGHT

string

Mantente bien.

MAKE_UTURN

string

Haz un giro.

MOTORWAY_EXIT_LEFT

string

Tome la salida izquierda.

MOTORWAY_EXIT_RIGHT

string

Tome la salida correcta.

ROUNDABOUT_BACK

string

Ve por la rotonda.

ROUNDABOUT_CROSS

string

Cruza la rotonda.

ROUNDABOUT_LEFT

string

En la rotonda, tome la salida a la izquierda.

ROUNDABOUT_RIGHT

string

En la rotonda, tome la salida a la derecha.

SHARP_LEFT

string

Gire a la izquierda afilada.

SHARP_RIGHT

string

Gire a la derecha.

STRAIGHT

string

Mantente en línea.

SWITCH_MAIN_ROAD

string

Cambie a la carretera principal.

SWITCH_PARALLEL_ROAD

string

Cambie a la carretera paralela.

TAKE_EXIT

string

Tome la salida.

TAKE_FERRY

string

Tome el ferry.

TRY_MAKE_UTURN

string

Intenta hacer un giro U.

TURN_LEFT

string

Gire a la izquierda.

TURN_RIGHT

string

Gire a la derecha.

WAYPOINT_LEFT

string

Ha llegado al punto de acceso. Está a la izquierda.

WAYPOINT_REACHED

string

Ha llegado al punto de acceso.

WAYPOINT_RIGHT

string

Ha llegado al punto de acceso. Está a la derecha.

InclineLevel

Grado de colina para la emocionante ruta. Este parámetro solo se puede usar junto con routeType=emocionante.

Nombre Tipo Description
high

string

Alto

low

string

Bajo

normal

string

normal

JunctionType

Tipo de unión donde se realiza la maniobra. Para los redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.

Nombre Tipo Description
BIFURCATION

string

bifurcación

REGULAR

string

regular

ROUNDABOUT

string

rotonda

LatLongPair

Ubicación representada como latitud y longitud.

Nombre Tipo Description
latitude

number

Latitude (propiedad)

longitude

number

Longitud (propiedad)

Report

Especifica qué datos se deben notificar con fines de diagnóstico. El único valor posible es effectiveSettings. Informa de los parámetros o datos efectivos que se usan al llamar a la API. En el caso de los parámetros predeterminados, el valor predeterminado se reflejará donde el autor de la llamada no especificó el parámetro.

Nombre Tipo Description
effectiveSettings

string

Informa de los parámetros o datos efectivos que se usan al llamar a la API.

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre Tipo Description
json

string

el formato de intercambio de datos de notación de objetos JavaScript

xml

string

el lenguaje de marcado extensible

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada

Nombre Tipo Description
CARPOOL

string

Secciones de la ruta que requieren el uso de carpool (vehículo de alta ocupación HOV/vehículos de alta ocupación).

CAR_TRAIN

string

Secciones de la ruta que son coches o trenes.

COUNTRY

string

Secciones que indican en qué países o regiones se encuentra la ruta.

FERRY

string

Secciones de la ruta que son ferries.

MOTORWAY

string

Secciones de la ruta que son autopistas.

PEDESTRIAN

string

Secciones de la ruta que solo son adecuadas para los peatones.

TOLL_ROAD

string

Secciones de la ruta que requieren que se pague un peaje.

TOLL_VIGNETTE

string

Secciones de la ruta que requieren que haya una viñeta de peaje.

TRAFFIC

string

Secciones de la ruta que contienen información de tráfico.

TRAVEL_MODE

string

Secciones en relación con el parámetro de solicitud travelMode.

TUNNEL

string

Secciones de la ruta que son túneles.

URBAN

string

Secciones de la ruta que se encuentran dentro de las zonas urbanas.

ResponseTravelMode

Modo de desplazamiento para la ruta calculada. El valor se establecerá en other si el modo de transporte solicitado no es posible en esta sección.

Nombre Tipo Description
bicycle

string

Las rutas devueltas están optimizadas para bicicletas, incluido el uso de carriles de bicicletas.

bus

string

Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo las carriles de autobús. Funcionalidad BETA.

car

string

Las rutas devueltas están optimizadas para automóviles.

motorcycle

string

Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.

other

string

El modo de transporte dado no es posible en esta sección.

pedestrian

string

Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.

taxi

string

Las rutas devueltas están optimizadas para taxis. Funcionalidad BETA.

truck

string

Las rutas devueltas están optimizadas para vehículos comerciales, como para camiones.

van

string

Las rutas devueltas están optimizadas para las camionetas. Funcionalidad BETA.

Route

Nombre Tipo Description
guidance

RouteGuidance

Contiene elementos relacionados con instrucciones. Este campo solo está presente cuando se solicitó la guía y está disponible.

legs

RouteLeg[]

Matriz de piernas

sections

RouteSection[]

Matriz de secciones

summary

RouteSummary

Summary (objeto)

RouteAvoidType

Especifica algo que el cálculo de ruta debe intentar evitar al determinar la ruta. Se puede especificar varias veces en una solicitud, por ejemplo, "&avoid=autopistas&avoid=tollRoads&avoid=ferries". En las solicitudes de intervalo de rutas, no se debe usar el valor alreadyUsedRoads.

Nombre Tipo Description
alreadyUsedRoads

string

Evita usar la misma carretera varias veces. Lo más útil junto con routeType=emocionante.

borderCrossings

string

Evita los cruces de bordes en el cálculo de rutas.

carpools

string

Evita las rutas que requieren el uso de la cola de coches (vehículo de alta ocupación) de los carriles.

ferries

string

Evita los ferris

motorways

string

Evita las autopistas

tollRoads

string

Evita las carreteras de peaje.

unpavedRoads

string

Evita carreteras sin pintar

RouteDirectionParameters

Publique los parámetros del cuerpo para las direcciones de ruta.

Nombre Tipo Description
allowVignette

string[]

Se trata de una lista de códigos de país iso 3166-1, alfa-3 de países o regiones en los que se permiten carreteras de peaje con viñetas, por ejemplo, "AUS,CHE". Especificar allowVignette con algunos países o regiones X equivale a especificar evitarVignette con todos los países o regiones, pero X. Especificar allowVignette con una lista vacía es el mismo que evitar todas las carreteras de peaje con viñetas. Nota: Se trata de un error especificar tanto evitarVignette y allowVignette.

avoidAreas

GeoJsonMultiPolygon

GeoJSON MultiPolygon que representa la lista de áreas que se van a evitar. Solo se admiten polígonos de rectángulo. El tamaño máximo de un rectángulo es de aproximadamente 160x160 km. El número máximo de áreas evitadas es 10. No puede cruzar el meridiano 180. Debe estar entre -80 y +80 grados de latitud.

avoidVignette

string[]

Esta es una lista de códigos de país de 3 caracteres, ISO 3166-1, alfa-3 de países o regiones en los que se deben evitar todas las carreteras de peaje con viñetas, por ejemplo, "AUS,CHE". Las carreteras de peaje con viñetas en países o regiones que no están en la lista no se ven afectadas. Nota: Se trata de un error especificar tanto evitarVignette y allowVignette.

supportingPoints

GeoJsonGeometryCollection

Colección de geometría GeoJSON que representa la secuencia de coordenadas usadas como entrada para la reconstrucción de rutas y para calcular cero o más rutas alternativas a esta ruta de referencia.

  • La secuencia proporcionada de puntos auxiliares se usa como entrada para la reconstrucción de rutas.
  • Las rutas alternativas se calculan entre los puntos de origen y destino especificados en las ubicaciones de parámetros de ruta de acceso base.
  • Si tanto minDeviationDistance y minDeviationTime se establecen en cero, se espera que estos puntos de origen y destino estén en (o muy cerca) el principio y el final de la ruta de referencia, respectivamente.
  • No se admiten ubicaciones intermedias (puntos de acceso) al usar <admitePoints>.
  • La ruta de referencia puede contener incidentes de tráfico de tipo ROAD_CLOSURE, que se omiten para el cálculo del tiempo de desplazamiento y el retraso del tráfico de la ruta de referencia. Consulte de puntos auxiliares para obtener más información.

RouteDirections

Este objeto se devuelve de una llamada a Route Directions correcta.

Nombre Tipo Description
formatVersion

string

Propiedad Format Version

optimizedWaypoints

RouteOptimizedWaypoint[]

Secuencia optimizada de puntos de referencia. Muestra el índice de la secuencia de punto de acceso proporcionada por el usuario para la lista original y optimizada. Por ejemplo, una respuesta:

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

significa que la secuencia original es [0, 1, 2] y la secuencia optimizada es [1, 2, 0]. Puesto que el índice comienza por 0, el original es "primero, segundo, tercero" mientras que el optimizado es "segundo, tercero, primero".

report

RouteReport

Informa de la configuración efectiva que se usa en la llamada actual.

routes

Route[]

Matriz de rutas

RouteGuidance

Contiene elementos relacionados con instrucciones. Este campo solo está presente cuando se solicitó la guía y está disponible.

Nombre Tipo Description
instructionGroups

RouteInstructionGroup[]

Agrupa una secuencia de elementos de instrucción que se relacionan entre sí.

instructions

RouteInstruction[]

Lista de instrucciones que describen maniobras.

RouteInstruction

Un conjunto de atributos que describen una maniobra, por ejemplo, "Girar a la derecha", "Mantener la izquierda", "Tomar el ferry", "Tomar la autopista", "Llegar".

Nombre Tipo Description
combinedMessage

string

Un mensaje legible para la maniobra combinada con el mensaje de la siguiente instrucción. A veces es posible combinar dos instrucciones sucesivas en una sola instrucción, lo que facilita el seguimiento. Cuando este es el caso, la marca possibleCombineWithNext será true. Por ejemplo:

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

La marca possibleCombineWithNext en la instrucción 10 es true. Esto indica a los clientes de instrucciones codificadas que se pueden combinar con la instrucción 11. Las instrucciones se combinarán automáticamente para los clientes que solicitan instrucciones legibles. El campo combinedMessage contiene el mensaje combinado:

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

string

3 caracteres código de país ISO 3166-1 código de país alfa-3. Por ejemplo, EE. UU.

drivingSide

DrivingSide

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.

exitNumber

string

Número de una salida de autopista tomada por la maniobra actual. Si una salida tiene varios números de salida, se separarán por "," y posiblemente se agregarán por "-", por ejemplo, "10, 13-15".

instructionType

GuidanceInstructionType

Tipo de instrucción, por ejemplo, giro o cambio de forma de carretera.

junctionType

JunctionType

Tipo de unión donde se realiza la maniobra. Para los redondeos más grandes, se generan dos instrucciones independientes para entrar y salir de la rotonda.

maneuver

GuidanceManeuver

Código que identifica la maniobra.

message

string

Un mensaje legible para la maniobra.

point

LatLongPair

Ubicación representada como latitud y longitud.

pointIndex

integer

Índice del punto de la lista de "puntos" de polilínea correspondiente al punto de la instrucción.

possibleCombineWithNext

boolean

Opcionalmente, es posible combinar la instrucción con la siguiente. Esto se puede usar para compilar mensajes como "Turn left and then turn right" (Girar a la izquierda y, a continuación, girar a la derecha).

roadNumbers

string[]

Los números de carretera de los siguientes segmentos significativos de carretera después de la maniobra, o de las carreteras que se van a seguir. Ejemplo: ["E34", "N205"]

roundaboutExitNumber

integer

Esto indica qué salida se va a tomar en una rotonda.

routeOffsetInMeters

integer

Distancia desde el inicio de la ruta hasta el punto de la instrucción.

signpostText

string

Texto sobre un cartel que es más relevante para la maniobra, o hacia la dirección que se debe seguir.

stateCode

string

Subdivisión (por ejemplo, estado) del país, representada por la segunda parte de una código iso 3166-2. Esto solo está disponible para algunos países o regiones como Estados Unidos, Canadá y México.

street

string

Nombre de la calle del siguiente segmento significativo de carretera después de la maniobra, o de la calle que debe seguirse.

travelTimeInSeconds

integer

Tiempo de viaje estimado hasta el punto correspondiente a routeOffsetInMeters.

turnAngleInDecimalDegrees

integer

Indica la dirección de una instrucción. Si junctionType indica una instrucción turn:

  • 180 = U-turn
  • [-179, -1] = Giro a la izquierda
  • 0 = Recta en (un giro '0 grados')
  • [1, 179] = Turno a la derecha

Si junctionType indica una instrucción de bifurcación:

  • <0: mantener la izquierda
  • >0: mantener la derecha

RouteInstructionGroup

Agrupa una secuencia de elementos de instrucción que se relacionan entre sí. El intervalo de secuencia está restringido con firstInstructionIndex y lastInstructionIndex. Cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetados), el elemento instructionGroup tiene un mensaje de resumen devuelto cuando está disponible.

Nombre Tipo Description
firstInstructionIndex

integer

Índice de la primera instrucción de las instrucciones y pertenencia a este grupo.

groupLengthInMeters

integer

Longitud del grupo.

groupMessage

string

Mensaje de resumen cuando se solicitan mensajes de texto legibles para instrucciones (instructionType=text o etiquetado).

lastInstructionIndex

integer

Índice de la última instrucción de las instrucciones y pertenencia a este grupo.

RouteInstructionsType

Si se especifica, se devolverán instrucciones. Tenga en cuenta que el parámetro instructionsType no se puede usar junto con routeRepresentation=none.

Nombre Tipo Description
coded

string

Devuelve datos de instrucción sin procesar sin mensajes legibles.

tagged

string

Devuelve datos de instrucción sin procesar con mensajes legibles etiquetados para permitir el formato. Un mensaje legible se crea a partir de elementos identificados repetibles. Se etiquetan para permitir que las aplicaciones cliente las dé formato correctamente. Los siguientes componentes de mensaje se etiquetan cuando instructionsType=tagged: street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

Ejemplo de mensaje "Turn left" etiquetado:

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

string

Devuelve datos de instrucciones sin procesar con mensajes legibles en texto sin formato.

RouteLeg

Descripción de una parte de una ruta, formada por una lista de puntos. Cada punto de acceso adicional proporcionado en la solicitud dará como resultado una etapa adicional en la ruta devuelta.

Nombre Tipo Description
points

LatLongPair[]

Matriz de puntos

summary

RouteLegSummary

Objeto de resumen para la sección de ruta.

RouteLegSummary

Objeto de resumen para la sección de ruta.

Nombre Tipo Description
arrivalTime

string

Hora estimada de llegada para la ruta o la pierna. La hora está en UTC.

batteryConsumptionInkWh

number

Consumo estimado de energía eléctrica en kilowatt hours (kWh) utilizando el modelo de consumo eléctrico. Se incluye si vehicleEngineType se establece en electric y constantSpeedConsumptionInkWhPerHundredkm se especifica. El valor de batteryConsumptionInkWh incluye la energía eléctrica recuperada y, por tanto, puede ser negativo (lo que indica la obtención de energía). Si se especifican maxChargeInkWh y currentChargeInkWh, se limitará la recuperación para asegurarse de que el nivel de carga de la batería nunca supere maxChargeInkWh. Si no se especifican maxChargeInkWh ni currentChargeInkWh, se asume la recuperación sin restricciones en el cálculo del consumo.

departureTime

string

Hora estimada de salida para la ruta o la pierna. La hora está en UTC.

fuelConsumptionInLiters

number

Consumo estimado de combustible en litros utilizando el modelo de consumo de combustión. Se incluye si vehicleEngineType se establece en de combustión y se especifica constantSpeedConsumptionInLitersPerHundredkm. El valor no será negativo.

historicTrafficTravelTimeInSeconds

integer

Tiempo estimado de viaje calculado mediante datos de tráfico histórico dependientes del tiempo. Solo se incluye si computeAdvisorTimeFor = todo se usa en la consulta.

lengthInMeters

integer

Length In Meters (propiedad)

liveTrafficIncidentsTravelTimeInSeconds

integer

Tiempo estimado de viaje calculado mediante datos de velocidad en tiempo real. Solo se incluye si computeAdvisorTimeFor = todo se usa en la consulta.

noTrafficTravelTimeInSeconds

integer

Tiempo estimado de viaje calculado como si no hay retrasos en la ruta debido a condiciones de tráfico (por ejemplo, congestión). Solo se incluye si computeAdvisorTimeFor = todo se usa en la consulta.

trafficDelayInSeconds

integer

Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico, es necesario agregar el parámetro computeAdvisorTimeFor=all.

travelTimeInSeconds

integer

Tiempo estimado de viaje en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula con datos de tráfico histórico dependientes del tiempo.

RouteOptimizedWaypoint

Objeto de punto de forma optimizado.

Nombre Tipo Description
optimizedIndex

integer

Índice de punto de forma optimizado desde el sistema.

providedIndex

integer

Índice de punto de acceso proporcionado por el usuario.

RouteReport

Informa de la configuración efectiva que se usa en la llamada actual.

Nombre Tipo Description
effectiveSettings

EffectiveSetting[]

Parámetros o datos efectivos usados al llamar a route API.

RouteRepresentationForBestOrder

Especifica la representación del conjunto de rutas proporcionadas como respuesta.

Nombre Tipo Description
none

string

Incluye solo los índices de punto de acceso optimizados, pero no incluye la geometría de ruta en la respuesta. Este valor de parámetro solo se puede usar junto con computeBestOrder=true.

polyline

string

Incluye geometría de ruta en la respuesta.

summaryOnly

string

Resumen según polilínea, pero sin incluir los elementos de geometría de punto para las rutas de la respuesta.

RouteSection

Las secciones de ruta contienen información adicional sobre las partes de una ruta. Cada sección contiene al menos los elementos startPointIndex, endPointIndexy sectionType.

Nombre Tipo Description
delayInSeconds

integer

Retraso en segundos causado por el incidente.

effectiveSpeedInKmh

integer

Velocidad efectiva del incidente en km/h, promedio en toda su longitud.

endPointIndex

integer

Índice del último punto (desplazamiento 0) de la ruta a la que se aplica esta sección.

magnitudeOfDelay

DelayMagnitude

Magnitud del retraso causado por el incidente. Estos valores corresponden a los valores del campo de respuesta del Get Traffic Incident Detail API.

sectionType

ResponseSectionType

Tipos de sección de la respuesta de ruta notificada

simpleCategory

SimpleCategory

Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTROS. Consulte "tec" para obtener información detallada.

startPointIndex

integer

Índice del primer punto (desplazamiento 0) de la ruta a la que se aplica esta sección.

tec

RouteSectionTec

Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC de . Puede contener effectCode y provoca elementos.

travelMode

ResponseTravelMode

Modo de desplazamiento para la ruta calculada. El valor se establecerá en other si el modo de transporte solicitado no es posible en esta sección.

RouteSectionTec

Detalles del evento de tráfico, usando definiciones en el estándar TPEG2-TEC de . Puede contener effectCode y provoca elementos.

Nombre Tipo Description
causes

RouteSectionTecCause[]

Causas de la matriz

effectCode

integer

Efecto en el flujo de tráfico. Contiene un valor en la tabla tec001:EffectCode, tal como se define en el estándar TPEG2-TEC de . Se puede usar para codificar los eventos de tráfico de color según la gravedad.

RouteSectionTecCause

Causa del evento de tráfico. Puede contener elementos mainCauseCode y subCauseCode. Se puede usar para definir la iconografía y las descripciones.

Nombre Tipo Description
mainCauseCode

integer

Causa principal del evento de tráfico. Contiene un valor en la tabla tec002:CauseCode, tal como se define en el estándar TPEG2-TEC .

subCauseCode

integer

Subcause del evento de tráfico. Contiene un valor en la tabla de sub causa definida por mainCauseCode, tal como se define en el estándar TPEG2-TEC de .

RouteSummary

Summary (objeto)

Nombre Tipo Description
arrivalTime

string

Hora estimada de llegada para la ruta o la pierna. La hora está en UTC.

departureTime

string

Hora estimada de salida para la ruta o la pierna. La hora está en UTC.

lengthInMeters

integer

Length In Meters (propiedad)

trafficDelayInSeconds

integer

Retraso estimado en segundos causado por los incidentes en tiempo real según la información de tráfico. En el caso de las rutas planeadas con la hora de salida en el futuro, los retrasos siempre son 0. Para devolver tiempos de desplazamiento adicionales mediante diferentes tipos de información de tráfico, es necesario agregar el parámetro computeAdvisorTimeFor=all.

travelTimeInSeconds

integer

Tiempo estimado de viaje en segundos propiedad que incluye el retraso debido al tráfico en tiempo real. Tenga en cuenta que incluso cuando traffic=false travelTimeInSeconds todavía incluye el retraso debido al tráfico. Si DepartAt está en el futuro, el tiempo de viaje se calcula con datos de tráfico histórico dependientes del tiempo.

RouteType

Tipo de ruta solicitada.

Nombre Tipo Description
eco

string

Una ruta equilibrada por economía y velocidad.

fastest

string

La ruta más rápida.

shortest

string

La ruta más corta por distancia.

thrilling

string

Incluye carreteras interesantes o desafiantes y utiliza tan pocas autopistas como sea posible. Puede elegir el nivel de giro incluido y también el grado de colina. Consulte los parámetros de colina y desplazamiento para saber cómo establecer esto. Hay un límite de 900 km en las rutas planeadas con routeType=emocionante

SectionType

Especifica cuál de los tipos de sección se notifica en la respuesta de ruta.

Por ejemplo, si sectionType = peatonal se devuelven las secciones que son adecuadas para los peatones. Se puede especificar varias veces en una solicitud, por ejemplo, "§ionType=carTrain§ionType=pedestrian§ionType=autopista". El valor predeterminado sectionType hace referencia a la entrada travelMode. De forma predeterminada travelMode está establecido en coche

Nombre Tipo Description
carTrain

string

Secciones de la ruta que son coches o trenes.

carpool

string

Secciones de la ruta que requieren el uso de carpool (vehículo de alta ocupación HOV/vehículos de alta ocupación).

country

string

Secciones que indican en qué países o regiones se encuentra la ruta.

ferry

string

Secciones de la ruta que son ferries.

motorway

string

Secciones de la ruta que son autopistas.

pedestrian

string

Secciones de la ruta que solo son adecuadas para los peatones.

tollRoad

string

Secciones de la ruta que requieren que se pague un peaje.

tollVignette

string

Secciones de la ruta que requieren que haya una viñeta de peaje.

traffic

string

Secciones de la ruta que contienen información de tráfico.

travelMode

string

Secciones en relación con el parámetro de solicitud travelMode.

tunnel

string

Secciones de la ruta que son túneles.

urban

string

Secciones de la ruta que se encuentran dentro de las zonas urbanas.

SimpleCategory

Tipo del incidente. Actualmente puede ser JAM, ROAD_WORK, ROAD_CLOSURE u OTROS. Consulte "tec" para obtener información detallada.

Nombre Tipo Description
JAM

string

Atasco.

OTHER

string

Otro.

ROAD_CLOSURE

string

Cierre de carreteras.

ROAD_WORK

string

Trabajo de carretera.

TravelMode

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "car". Tenga en cuenta que el travelMode solicitado puede no estar disponible para toda la ruta. Cuando el travelMode solicitado no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro". Tenga en cuenta que los modos de viaje bus, motocicleta, taxi y van son funcionalidad BETA. Los datos de restricción completa no están disponibles en todas las áreas.

Nombre Tipo Description
bicycle

string

Las rutas devueltas están optimizadas para bicicletas, incluido el uso de carriles de bicicletas.

bus

string

Las rutas devueltas están optimizadas para los autobuses, incluido el uso de solo las carriles de autobús. Funcionalidad BETA.

car

string

Las rutas devueltas están optimizadas para automóviles.

motorcycle

string

Las rutas devueltas están optimizadas para motocicletas. Funcionalidad BETA.

pedestrian

string

Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.

taxi

string

Las rutas devueltas están optimizadas para taxis. Funcionalidad BETA.

truck

string

Las rutas devueltas están optimizadas para vehículos comerciales, como para camiones.

van

string

Las rutas devueltas están optimizadas para las camionetas. Funcionalidad BETA.

VehicleEngineType

Tipo de motor del vehículo. Cuando se especifica un modelo de consumo detallado, debe ser coherente con el valor de vehicleEngineType.

Nombre Tipo Description
combustion

string

Motor de combustión interna.

electric

string

Motor eléctrico.

VehicleLoadType

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 o regiones. 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 o regiones. vehicleLoadType se puede especificar varias veces. Este parámetro solo se considera actualmente para travelMode=truck.

Nombre Tipo Description
USHazmatClass1

string

Explosivos

USHazmatClass2

string

Gas comprimido

USHazmatClass3

string

Líquidos inflamables

USHazmatClass4

string

Sólidos inflamables

USHazmatClass5

string

Oxidantes

USHazmatClass6

string

Venenos

USHazmatClass7

string

Radiactivo

USHazmatClass8

string

Corrosivos

USHazmatClass9

string

Misceláneo

otherHazmatExplosive

string

Explosivos

otherHazmatGeneral

string

Misceláneo

otherHazmatHarmfulToWater

string

Perjudicial para el agua

WindingnessLevel

Nivel de giros para una ruta emocionante. Este parámetro solo se puede usar junto con routeType=emocionante.

Nombre Tipo Description
high

string

Alto

low

string

Bajo

normal

string

normal