Weather - Get Weather Along Route
Úselo para obtener un pronóstico preciso y up-tominuto que incluya evaluaciones de peligros meteorológicos y notificaciones a lo largo de una ruta.
La Get Weather Along Route
API es una solicitud HTTP GET
que devuelve pronósticos meteorológicos hiperlocales (un kilómetro o menos) up-tominuto a minuto, evaluaciones de riesgos meteorológicos y notificaciones a lo largo de una ruta descrita como una secuencia de puntos de referencia.
Esto incluye una lista de peligros climáticos que afectan el punto de referencia o la ruta, y el índice de peligro agregado para cada punto de referencia se puede usar para pintar cada parte de una ruta de acuerdo con qué tan segura es para el conductor. Al enviar los puntos de referencia, se recomienda permanecer dentro o cerca de la distancia que se puede recorrer dentro de los 120 minutos o poco después. Los datos se actualizan cada cinco minutos.
El servicio complementa el servicio de rutas 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 Tiempo a lo largo de la ruta.
Además, el servicio admite escenarios para generar notificaciones meteorológicas para puntos de referencia que experimentan un aumento en la intensidad de un peligro meteorológico. Por ejemplo, si se espera que el vehículo comience a experimentar lluvias intensas al llegar a un punto de referencia, se generará una notificación meteorológica de lluvia intensa para ese punto de referencia, lo que permitirá que el producto final muestre una notificación de lluvia intensa antes de que el conductor llegue a ese punto de referencia. El desencadenante de cuándo mostrar la notificación para un punto de referencia podría basarse, por ejemplo, en una geocerca o en una distancia seleccionable al punto de referencia.
El 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}
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 |
Formato deseado de la respuesta. Solo se admite |
|
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 (:) e introducidas en orden cronológico. Se requiere un mínimo de dos puntos de referencia. Una sola llamada a la API puede contener hasta 60 waypoints. Un punto de referencia indica la ubicación, la hora estimada de llegada y el rumbo opcional: latitud, longitud, hora estimada de llegada, rumbo, dónde
Se recomienda permanecer dentro o cerca de la distancia que se puede recorrer dentro de los 120 minutos o poco después. De esta manera, se puede proporcionar una evaluación más precisa del viaje y evitar que los eventos aislados no se capturen entre los puntos de referencia. La información puede y debe actualizarse a lo largo de la ruta (especialmente para viajes de más de 2 horas) para extraer continuamente nuevos puntos de referencia en el futuro, pero también para garantizar que la información de pronóstico para el contenido, como el tipo y la intensidad de la precipitación, sea precisa a medida que las tormentas se desarrollan y se disipan con el tiempo. |
language
|
query |
string |
Idioma en el que se deben devolver los resultados de la 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
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
De acuerdo |
|
Other Status Codes |
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 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.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
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 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
{
"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 |
---|---|
Error |
Información adicional sobre el error de administración de recursos. |
Error |
Detalle del error. |
Error |
Respuesta de error |
Hazard |
|
Hazard |
Un índice de gravedad/peligrosidad.
|
Icon |
Valor numérico que representa una imagen que muestra el |
Json |
Formato deseado de la respuesta. Solo se admite |
Sun |
Una clasificación que indica lo cegador que es el sol para el conductor. |
Unit |
Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información. |
Weather |
Previsión de precipitaciones del tiempo a lo largo del recorrido. |
Weather |
Este objeto se devuelve de una ruta meteorológica a lo largo de la correcta. |
Weather |
Breve resumen del tiempo a lo largo de la ruta. |
Weather |
Descripción del peligro meteorológico que afecta al viaje. |
Weather |
|
Weather |
Valor específico de una unidad dada en relación con el clima. |
Weather |
|
Wind |
Se devuelven los detalles del viento, incluida la velocidad y la dirección. |
Wind |
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 |
Información adicional del error. |
|
code |
string |
Código de error. |
details |
Detalles del error. |
|
message |
string |
El mensaje de error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
HazardDetail
Nombre | Tipo | Description |
---|---|---|
hazardCode |
string |
Un identificador único (no visualizable) para cada tipo de peligro: Lluvia ligera, Lluvia moderada, Lluvia intensa, Mezcla ligera, Mezcla moderada, Mezcla pesada, Nieve ligera, Nieve moderada, Nieve pesada, Hielo ligero, Hielo moderado, Hielo pesado, Granizo, Granizo, Granizo, Deslumbramiento del solAlto, Relámpago, SeveroRelámpago, VientoModerado, Viento Alto, Viento extremo, Advertencia de inundación, Advertencia de inundación repentina, Advertencia de tornado, Advertencia de tsunami, Advertencia de tormenta eléctrica severa. |
hazardIndex |
Hazard |
Un índice de gravedad/peligrosidad.
|
shortPhrase |
string |
Una frase corta desplegable que describe las condiciones pronosticadas y la intensidad/tipo de precipitación. |
HazardIndex
Un índice de gravedad/peligrosidad.
-
0
- No hay peligro. -
1
- Mantente informado, sé consciente. -
2
- Presta atención, prepárate. -
3
- Actúa. -
4
- Peligro de vida, emergencia.
Valor | Description |
---|---|
0 |
Sin peligro |
1 |
Mantente informado |
2 |
Prestar atención |
3 |
Realizar acción |
4 |
Emergencia |
IconCode
Valor numérico que representa una imagen que muestra el iconPhrase
archivo . Consulte Servicios meteorológicos en Azure Maps para obtener más información.
Valor | Description |
---|---|
1 |
Soleado |
10 | |
11 |
Niebla |
12 |
Chubascos |
13 |
Principalmente nublado con chubascos |
14 |
Parcialmente soleado con chubascos |
15 |
Tormentas |
16 |
Principalmente nublado con tormenta |
17 |
Parcialmente soleado con tormenta |
18 |
Lluvia |
19 |
Nevisca |
2 |
Principalmente soleado |
20 |
Principalmente nublado con nevisca |
21 |
Principalmente soleado con nevisca |
22 |
Nieve |
23 |
Principalmente nublado con nieve |
24 |
Hielo |
25 |
Aguanieve |
26 |
Lluvia helada |
27 | |
28 | |
29 |
Lluvia y nieve |
3 |
Parcialmente soleado |
30 |
Caliente |
31 |
Frío |
32 |
Viento |
33 |
Claro |
34 |
Principalmente despejado |
35 |
Parcialmente nublado |
36 |
Nubes intermitentes (noche) |
37 |
Calima |
38 |
Mayormente nublado (noche) |
39 |
Parcialmente nublado con chubascos |
4 |
Nubes intermitentes |
40 |
Mayormente nublado con chubascos (noche) |
41 |
Parcialmente nublado con tormenta |
42 |
Mayormente nublado con tormentas eléctricas (noche) |
43 |
Mayormente nublado con ráfagas (Noche) |
44 |
Mayormente nublado con nieve (noche) |
5 |
Calima |
6 |
Principalmente nublado |
7 |
Turbio |
8 |
Cubierto |
9 |
JsonFormat
Formato deseado de la respuesta. Solo se admite json
formato.
Valor | Description |
---|---|
json |
el formato de intercambio de datos de notación de objetos JavaScript |
SunGlare
Una clasificación que indica lo cegador que es el sol para el conductor.
Nombre | Tipo | Description |
---|---|---|
calculatedVehicleHeading |
integer (int32) |
Si no se proporciona el valor de rumbo del vehículo para un punto de referencia, el servicio calculará un rumbo en función de la ubicación de los puntos de referencia vecinos, si se proporciona. |
glareIndex |
integer (int32) |
Un índice de 0 a 100 que indica la intensidad del deslumbramiento del sol para un conductor. Un valor de 50 o más puede considerarse un peligro para algunos conductores, y un valor de 100 significa que el conductor está conduciendo directamente hacia el sol y las condiciones atmosféricas son claras, lo que permite que la intensidad total del sol cegue al conductor. |
UnitType
Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información.
Valor | Description |
---|---|
0 |
pies |
1 |
Pulgadas |
10 |
metrospor segundo |
11 |
hectoPascales |
12 |
pulgadasOfMercurio |
13 |
kiloPascales |
14 |
Milibares |
15 |
milímetrosDeMercurio |
16 |
librasPorPulgada Cuadrada |
17 |
grados centígrados |
18 |
grados Fahrenheit |
19 |
grados Kelvin |
2 |
millas |
20 |
por ciento |
21 |
flotante |
22 |
entero |
3 |
Milímetro |
31 |
MicrogramosPerCubicMeterOfAir |
4 |
centímetro |
5 |
Metro |
6 |
kilómetro |
7 |
kilómetrosPor hora |
8 |
Nudos |
9 |
millasPor hora |
WeatherAlongRoutePrecipitation
Previsión de precipitaciones del tiempo a lo largo del recorrido.
Nombre | Tipo | Description |
---|---|---|
dbz |
number (double) |
La intensidad de precipitación pronosticada en dBZ (decibelios en relación con Z) de 0.0 a 100.0. |
type |
string |
Tipo de precipitación. Si se produce precipitación, el tipo que será: "LLUVIA", "GRANIZO", "NIEVE", "HIELO" o "MEZCLA". |
WeatherAlongRouteResult
Este objeto se devuelve de una ruta meteorológica a lo largo de la correcta.
Nombre | Tipo | Description |
---|---|---|
summary |
Breve resumen del tiempo a lo largo de la ruta. |
|
waypoints |
Los datos de cada waypoint se devuelven 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 |
Descripción del peligro meteorológico que afecta al viaje. |
|
iconCode |
Icon |
Valor numérico que representa una imagen que muestra el |
WeatherHazards
Descripción del peligro meteorológico que afecta al viaje.
Nombre | Tipo | Description |
---|---|---|
hazardDetails |
Detalles de los peligros climáticos que afectan el viaje. |
|
maxHazardIndex |
Hazard |
Un índice de gravedad/peligrosidad.
|
WeatherNotification
Nombre | Tipo | Description |
---|---|---|
hazardCode |
string |
Un identificador único (no visualizable) para cada tipo de peligro: Lluvia ligera, Lluvia moderada, Lluvia intensa, Mezcla ligera, Mezcla moderada, Mezcla pesada, Nieve ligera, Nieve moderada, Nieve pesada, Hielo ligero, Hielo moderado, Hielo pesado, Granizo, Granizo, Granizo, Deslumbramiento del solAlto, Relámpago, SeveroRelámpago, VientoModerado, Viento Alto, Viento extremo, Advertencia de inundación, Advertencia de inundación repentina, Advertencia de tornado, Advertencia de tsunami, Advertencia de tormenta eléctrica severa. |
hazardIndex |
Hazard |
Un índice de gravedad/peligrosidad.
|
shortPhrase |
string |
Una frase corta desplegable que describe las condiciones pronosticadas y la intensidad/tipo de precipitación. |
type |
string |
Un tipo de notificación generada para advertir a los conductores de la aparición de un peligro o el aumento en la intensidad de un peligro. |
WeatherUnit
Valor específico de una unidad dada en relación con el clima.
Nombre | Tipo | Description |
---|---|---|
unit |
string |
Tipo de unidad para el valor devuelto. |
unitType |
Unit |
Valor de ID numérico asociado al tipo de unidad que se muestra. Se puede utilizar para la traducción de unidades. Consulte Servicios meteorológicos en Azure Maps para obtener más información. |
value |
number (float) |
Valor redondeado. |
WeatherWaypoint
Nombre | Tipo | Description |
---|---|---|
cloudCover |
integer (int32) |
Porcentaje que representa la nubosidad. |
hazards |
Descripción del peligro meteorológico que afecta al viaje. |
|
iconCode |
Icon |
Valor numérico que representa una imagen que muestra el |
isDayTime |
boolean |
Indica la hora del día. Verdadero indica 'día', falso indica 'noche'. |
lightningCount |
integer (int32) |
Estimación de la intensidad de las tormentas eléctricas en escala abierta. Un valor de 0 significa que no hay tormenta eléctrica; Los valores de 1 y superiores significan que hay una tormenta eléctrica con una intensidad creciente. |
notifications |
Listado de avisos de peligro meteorológico. |
|
precipitation |
Previsión de precipitaciones del tiempo a lo largo del recorrido. |
|
shortPhrase |
string |
Una frase corta desplegable que describe las condiciones pronosticadas y la intensidad/tipo de precipitación. |
sunGlare |
Una clasificación que indica lo cegador que es el sol para el conductor. |
|
temperature |
Valor específico de una unidad dada en relación con el clima. |
|
wind |
Se devuelven los detalles del viento, incluida la velocidad y la dirección. |
|
windGust |
Se devuelven los detalles del viento, incluida la velocidad y la dirección. |
WindDetails
Se devuelven los detalles del viento, incluida la velocidad y la dirección.
Nombre | Tipo | Description |
---|---|---|
direction |
Dirección del viento |
|
speed |
Velocidad del viento en unidad especificada. |
WindDirection
Dirección del viento
Nombre | Tipo | Description |
---|---|---|
degrees |
integer (int32) |
Dirección del viento en grados acimutales, comenzando en el norte verdadero y continuando en el sentido de 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 de 0 a 359. |
localizedDescription |
string |
Abreviatura de dirección en el idioma especificado. |