Compartir a través de

Weather - Get Weather Along Route

  • Referencia
Servicio:
Maps
Versión de la API:
1.1

Use para obtener una previsión precisa y precisa de ubicación que incluya notificaciones y evaluaciones de riesgos meteorológicos a lo largo de una ruta.

La Get Weather Along Route API es una solicitud HTTP GET que devuelve hiper local (un kilómetro o menos), el tiempo de hasta el minuto realiza ahora la difusión, las evaluaciones de riesgos meteorológicos y las notificaciones a lo largo de una ruta descrita como una secuencia de puntos de referencia. Esto incluye una lista de los peligros meteorológicos que afectan al punto de acceso o la ruta, y el índice de peligro agregado para cada punto de acceso se puede usar para pintar cada parte de una ruta según la seguridad que sea para el conductor. Al enviar los puntos de referencia, se recomienda permanecer dentro o cerca de ella, la distancia que se puede recorrer en 120 minutos o poco después. Los datos se actualizan cada cinco minutos.

El servicio complementa el servicio route de Azure Maps que permite solicitar primero una ruta entre un origen y un destino y usarla como entrada para el punto de conexión Weather Along Route.

Además, el servicio admite escenarios para generar notificaciones meteorológicas para puntos de referencia que experimentan un aumento de la intensidad de un peligro meteorológico. Por ejemplo, si se espera que el vehículo comience a experimentar lluvia intensa, ya que alcanza un punto de referencia, se generará una notificación meteorológica para ese punto de camino, lo que permitirá al producto final mostrar una notificación de lluvia intensa antes de que el conductor alcance ese punto de camino. El desencadenador para cuándo mostrar la notificación de un punto de referencia podría basarse, por ejemplo, en una geovalla o en una distancia seleccionable al punto de referencia.

La API cubre todas las regiones del planeta excepto las latitudes por encima de Groenlandia y la Antártida.

GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}
Con parámetros opcionales: 
GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query={query}&language={language}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
format
 path True

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.
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 cuales se calcula la ruta, separadas por dos puntos (:) y especificadas en orden cronológico. Se requiere un mínimo de dos puntos de referencia. Una sola llamada API puede contener hasta 60 puntos de referencia. Un punto de referencia indica la ubicación, ETA y el encabezado opcional: latitud, longitud, ETA, encabezado, donde

  • Latitude - Coordenada de latitud en grados decimales.
  • Longitude - Coordenada de longitud en grados decimales.
  • ETA (estimated time of arrival) - El número de minutos desde el momento actual que tardará el vehículo en llegar al punto de acceso. El intervalo permitido es de 0,0 a 120,0 minutos.
  • Heading - Valor opcional que indica el encabezado del vehículo a medida que pasa el punto de acceso. Expresado en grados en sentido de las agujas del reloj en relación con el norte verdadero. Esto se emite para calcular el resplandor solar como un peligro de conducción. El intervalo permitido es de 0,0 a 360,0 grados. Si no se proporciona, un encabezado se derivará automáticamente en función de la posición de los puntos de referencia vecinos.

Se recomienda permanecer dentro, o cerca de, la distancia que se puede recorrer dentro de 120 minutos o poco después. De este modo, se puede proporcionar una evaluación más precisa para el viaje y evitar que los eventos aislados no se capturen entre puntos de referencia. La información puede y debe actualizarse a lo largo de la ruta (especialmente para viajes superiores a 2 horas) para extraer continuamente nuevos puntos de referencia hacia adelante, pero también para asegurarse de que la información de previsión para contenido como el tipo de precipitación y la intensidad es precisa a medida que las tormentas se desarrollan y disipan con el tiempo.
language
 query

string

Idioma en el que se deben devolver los resultados de búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado.

Consulte Idiomas admitidos para obtener más información.

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 de id. de Microsoft Entra en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre Tipo Description
200 OK

WeatherAlongRouteResult

Aceptar
Other Status Codes

ErrorResponse

Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en rol 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 mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de 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 x-ms-client-id encabezado 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 .

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 mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del 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 crear 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.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para 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 trata de un token de firma de acceso compartido que se crea 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, la CLI, los SDK de Azure o las API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de 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 controlen 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 la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Successfully retrieve detailed weather casts along a route described as a sequence of waypoints

Solicitud de ejemplo

GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query=38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60

Respuesta de muestra

status code:
200 
{
  "summary": {
    "iconCode": 35,
    "hazards": {
      "maxHazardIndex": 0
    }
  },
  "waypoints": [
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 70,
      "temperature": {
        "value": 3.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 142
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 3,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 90,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 65,
      "temperature": {
        "value": 3.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 166
        },
        "speed": {
          "value": 1,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 77,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 43,
      "temperature": {
        "value": 3.2,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 163
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 44,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 34,
      "temperature": {
        "value": 1.6,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 189
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 32,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 54,
      "temperature": {
        "value": 0.5,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 202
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 36,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 46,
      "temperature": {
        "value": 2.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 222
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 38,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 39,
      "temperature": {
        "value": 2.3,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 231
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 43,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    }
  ]
}

Definiciones

Nombre Description
ErrorAdditionalInfo

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

Detalle del error.
ErrorResponse

Respuesta de error
HazardDetail
HazardIndex

Índice de gravedad/peligro.

  • 0 - Sin peligro.
  • 1 - Sé informado, ten en cuenta.
  • 2 - Preste atención, prepárese.
  • 3 - Tome medidas.
  • 4 - Amenaza de vida, emergencia.
IconCode

Valor numérico que representa una imagen que muestra .iconPhrase Consulte Servicios meteorológicos en Azure Maps para más información.
JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.
SunGlare

Una clasificación que indica cómo es cegado el sol para el conductor.
UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.
WeatherAlongRoutePrecipitation

Previsión de precipitaciones del tiempo a lo largo de la ruta.
WeatherAlongRouteResult

Este objeto se devuelve de una ruta Weather Along Route correcta.
WeatherAlongRouteSummary

Breve resumen del tiempo a lo largo de la ruta.
WeatherHazards

Descripción del peligro meteorológico que afecta al viaje.
WeatherNotification
WeatherUnit

Valor específico de una unidad determinada relacionada con el tiempo.
WeatherWaypoint
WindDetails

Detalles del viento que se devuelven, incluida la velocidad y la dirección.
WindDirection

Dirección del viento

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

Los detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

HazardDetail

Nombre Tipo Description
hazardCode

string

Un identificador único (no visible) para cada tipo de peligro: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindEmix, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.
hazardIndex

HazardIndex

Índice de gravedad/peligro.

  • 0 - Sin peligro.
  • 1 - Sé informado, ten en cuenta.
  • 2 - Preste atención, prepárese.
  • 3 - Tome medidas.
  • 4 - Amenaza de vida, emergencia.
shortPhrase

string

Frase abreviable que describe las condiciones previstas y la intensidad/tipo de precipitación.

HazardIndex

Índice de gravedad/peligro.

  • 0 - Sin peligro.
  • 1 - Sé informado, ten en cuenta.
  • 2 - Preste atención, prepárese.
  • 3 - Tome medidas.
  • 4 - Amenaza de vida, emergencia.
Nombre Tipo Description
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

IconCode

Valor numérico que representa una imagen que muestra .iconPhrase Consulte Servicios meteorológicos en Azure Maps para más información.

Nombre Tipo Description
1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre Tipo Description
json

string

Formato de intercambio de datos de notación de objetos JavaScript

SunGlare

Una clasificación que indica cómo es cegado el sol para el conductor.

Nombre Tipo Description
calculatedVehicleHeading

integer

Si el valor de encabezado del vehículo no se proporciona para un punto de referencia, el servicio calculará un encabezado en función de la ubicación de los puntos de referencia vecinos si se proporciona.
glareIndex

integer

Índice comprendido entre 0 y 100 que indica la intensidad del resplandor solar para un conductor. Un valor de 50 y superiores se puede considerar un peligro para algunos conductores y un valor de 100 significa que el conductor está conduciendo directamente al sol y las condiciones atmosféricas son claros, lo que permite la intensidad completa del sol para blindar al conductor.

UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.

Nombre Tipo Description
0

Integer

1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

3

Integer

31

Integer

4

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

WeatherAlongRoutePrecipitation

Previsión de precipitaciones del tiempo a lo largo de la ruta.

Nombre Tipo Description
dbz

number

La intensidad de precipitación prevista en dBZ (decibelios relativos a Z) de 0,0 a 100,0.
type

string

Tipo de precipitación. Si se deben producir precipitaciones, el tipo que será: "RAIN", "HAIL", "SNOW", "ICE" o "MIX".

WeatherAlongRouteResult

Este objeto se devuelve de una ruta Weather Along Route correcta.

Nombre Tipo Description
summary

WeatherAlongRouteSummary

Breve resumen del tiempo a lo largo de la ruta.
waypoints

WeatherWaypoint[]

Datos de cada punto de referencia devuelto en el mismo orden que se especifica en la solicitud.

WeatherAlongRouteSummary

Breve resumen del tiempo a lo largo de la ruta.

Nombre Tipo Description
hazards

WeatherHazards

Descripción del peligro meteorológico que afecta al viaje.
iconCode

IconCode

Valor numérico que representa una imagen que muestra .iconPhrase Consulte Servicios meteorológicos en Azure Maps para más información.

WeatherHazards

Descripción del peligro meteorológico que afecta al viaje.

Nombre Tipo Description
hazardDetails

HazardDetail[]

Detalles de los peligros meteorológicos que afectan al viaje.
maxHazardIndex

HazardIndex

Índice de gravedad/peligro.

  • 0 - Sin peligro.
  • 1 - Sé informado, ten en cuenta.
  • 2 - Preste atención, prepárese.
  • 3 - Tome medidas.
  • 4 - Amenaza de vida, emergencia.

WeatherNotification

Nombre Tipo Description
hazardCode

string

Un identificador único (no visible) para cada tipo de peligro: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindEmix, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.
hazardIndex

HazardIndex

Índice de gravedad/peligro.

  • 0 - Sin peligro.
  • 1 - Sé informado, ten en cuenta.
  • 2 - Preste atención, prepárese.
  • 3 - Tome medidas.
  • 4 - Amenaza de vida, emergencia.
shortPhrase

string

Frase abreviable que describe las condiciones previstas y la intensidad/tipo de precipitación.
type

string

Tipo de notificación generada para advertir a los conductores del inicio de un peligro o aumentar la intensidad de un peligro.

WeatherUnit

Valor específico de una unidad determinada relacionada con el tiempo.

Nombre Tipo Description
unit

string

Tipo de unidad para el valor devuelto.
unitType

UnitType

Valor de identificador numérico asociado al tipo de unidad que se muestra. Se puede usar para la traducción unitaria. Consulte Servicios meteorológicos en Azure Maps para más información.
value

number

Valor redondeado.

WeatherWaypoint

Nombre Tipo Description
cloudCover

integer

Porcentaje que representa la cobertura de la nube.
hazards

WeatherHazards

Descripción del peligro meteorológico que afecta al viaje.
iconCode

IconCode

Valor numérico que representa una imagen que muestra .iconPhrase Consulte Servicios meteorológicos en Azure Maps para más información.
isDayTime

boolean

Indica la hora del día. True indica "day", "false" indica "night".
lightningCount

integer

Estimación de la intensidad de las tormentas en una escala abierta. Un valor de 0 significa que no hay tormentas; valores de 1 y superior media hay una tormenta en intensidad creciente.
notifications

WeatherNotification[]

Lista de notificaciones de peligro meteorológico.
precipitation

WeatherAlongRoutePrecipitation

Previsión de precipitaciones del tiempo a lo largo de la ruta.
shortPhrase

string

Frase abreviable que describe las condiciones previstas y la intensidad/tipo de precipitación.
sunGlare

SunGlare

Una clasificación que indica cómo es cegado el sol para el conductor.
temperature

WeatherUnit

Valor específico de una unidad determinada relacionada con el tiempo.
wind

WindDetails

Detalles del viento que se devuelven, incluida la velocidad y la dirección.
windGust

WindDetails

Detalles del viento que se devuelven, incluida la velocidad y la dirección.

WindDetails

Detalles del viento que se devuelven, incluida la velocidad y la dirección.

Nombre Tipo Description
direction

WindDirection

Dirección del viento
speed

WeatherUnit

Velocidad del viento en la unidad especificada.

WindDirection

Dirección del viento

Nombre Tipo Description
degrees

integer

Dirección del viento en grados Azimuth, comenzando en el norte verdadero y continuando en dirección en sentido de las agujas del reloj. El norte es de 0 grados, este es de 90 grados, sur es de 180 grados, oeste es de 270 grados. Valores posibles entre 0 y 359.
localizedDescription

string

Abreviatura de dirección en el idioma especificado.