Weather - Get Weather Along Route
Umožňuje získat lokálně přesnou a minutovou předpověď, která zahrnuje posouzení povětrnostních rizik a oznámení na trase.
Rozhraní Get Weather Along Route
API je požadavek HTTP GET
, který vrací hyperlokály (jeden kilometr nebo méně), minutová aktuální předpověď počasí, posouzení nebezpečí počasí a oznámení na trase popsané jako posloupnost tras.
To zahrnuje seznam povětrnostních rizik ovlivňujících trasu nebo trasu a agregovaný index nebezpečí pro každý směrný bod může být použit k vykreslení každé části trasy podle toho, jak je bezpečná pro řidiče. Při odesílání waypointů se doporučuje zůstat v dosahu nebo blízko vzdálenosti, kterou je možné urazit během 120 minut nebo krátce po ní. Data se aktualizují každých pět minut.
Služba doplňuje službu Azure Maps Route Service, která umožňuje nejprve požádat o trasu mezi zdrojem a cílem a použít ji jako vstup pro koncový bod Weather Along Route.
Kromě toho služba podporuje scénáře generování oznámení o počasí pro waypointy, u které dochází ke zvýšení intenzity nebezpečí počasí. Pokud se například očekává, že u vozidla začne docházet k silnému dešti, jakmile dosáhne waypointu, vygeneruje se pro tento bod oznámení o počasí v případě silného deště, které umožní koncovému produktu zobrazit oznámení o silném dešti předtím, než řidič dosáhne daného bodu jízdy. Aktivační událost, kdy se má zobrazit oznámení pro waypoint, může být založená například na geografické fence nebo na vybrané vzdálenosti od waypointu.
Rozhraní API pokrývá všechny oblasti planety s výjimkou zeměpisných šířek nad Grónskem a Antarktidou.
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}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi. Podporuje se pouze |
|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. |
query
|
query | True |
string |
Souřadnice, přes které se trasa počítá, oddělené dvojtečkami (:) a zadané v chronologickém pořadí. Vyžadují se minimálně dva body cesty. Jedno volání rozhraní API může obsahovat až 60 waypointů. Waypoint označuje umístění, ETA a volitelné nadpisy: zeměpisná šířka, zeměpisná délka, ETA, nadpis, kde
Doporučuje se zůstat v rámci nebo blízko vzdálenosti, kterou lze urazit během 120 minut nebo krátce po ní. Tímto způsobem lze poskytnout přesnější posouzení cesty a zabránit zachycení izolovaných událostí mezi body cesty. Informace mohou a měly by být aktualizovány podél trasy (zejména pro cesty delší než 2 hodiny), aby se neustále vytáhly nové směrové body vpřed, ale také aby se zajistilo, že informace o předpovědích pro obsah, jako je typ srážek a intenzita, jsou přesné s tím, jak se v průběhu času vyvíjejí a rozplynou bouře. |
language
|
query |
string |
Jazyk, ve kterém se mají vracet výsledky hledání. Měl by být jednou z podporovaných značek jazyka IETF, nerozlišují se malá a velká písmena. Pokud data v zadaném jazyce nejsou pro konkrétní pole k dispozici, použije se výchozí jazyk. Podrobnosti najdete v části Podporované jazyky . |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Microsoft Entra ID. Představuje jedinečné ID účtu Azure Maps a je možné ho načíst z rozhraní API účtu roviny správy Azure Maps. Pokud chcete použít Microsoft Entra ID zabezpečení v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Došlo k neočekávané chybě. |
Zabezpečení
AADToken
Toto jsou Microsoft Entra toky OAuth 2.0. Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map .
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady Azure Maps Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o Microsoft identity platform najdete v přehledu Microsoft identity platform.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jedná se o sdílený klíč, který se zřídí při Create účtu Azure Maps v Azure Portal nebo pomocí PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace přístup ke všem rozhraním REST API. Jinými slovy, tento klíč se dá použít jako hlavní klíč v účtu, ve který je vystavený.
U veřejně vystavených aplikací doporučujeme používat pro přístup k rozhraním REST API Azure Maps přístup k důvěrným klientským aplikacím, aby se váš klíč mohl bezpečně uložit.
Type:
apiKey
In:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.
Type:
apiKey
In:
header
Příklady
Successfully retrieve detailed weather casts along a route described as a sequence of waypoints
Sample Request
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
Sample Response
{
"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": []
}
]
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Hazard |
|
Hazard |
Index závažnosti/nebezpečí.
|
Icon |
Číselná hodnota představující obrázek, který zobrazuje |
Json |
Požadovaný formát odpovědi Podporuje se pouze |
Sun |
Hodnocení, které udává, jak oslepující slunce pro řidiče. |
Unit |
Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v Azure Maps ve službách Počasí. |
Weather |
Předpověď srážek počasí na trase. |
Weather |
Tento objekt se vrátí z úspěšného weather Along Route. |
Weather |
Krátký přehled počasí na trase. |
Weather |
Popis nebezpečí počasí ovlivňujícího jízdu. |
Weather |
|
Weather |
Konkrétní hodnota dané jednotky související s počasím. |
Weather |
|
Wind |
Vrací se podrobnosti o větru, včetně rychlosti a směru. |
Wind |
Směr větru |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
HazardDetail
Name | Typ | Description |
---|---|---|
hazardCode |
string |
Jedinečný identifikátor (nezobrazovatelný) pro každý typ nebezpečí: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, SalesforceWarning, SevereThunderstormWarning. |
hazardIndex |
Index závažnosti/nebezpečí.
|
|
shortPhrase |
string |
Zobrazitelná krátká fráze popisující předpokládané podmínky a intenzitu/typ srážek. |
HazardIndex
Index závažnosti/nebezpečí.
0
- Žádné nebezpečí.1
- Buďte informovaní, mějte na paměti.2
- Dávej pozor, buďte připraveni.3
- Udělejte akci.4
- Život ohrožující, nouzový.
Name | Typ | Description |
---|---|---|
0 |
Integer |
|
1 |
Integer |
|
2 |
Integer |
|
3 |
Integer |
|
4 |
Integer |
IconCode
Číselná hodnota představující obrázek, který zobrazuje iconPhrase
. Podrobnosti najdete v Azure Maps ve službách Počasí.
Name | Typ | 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
Požadovaný formát odpovědi Podporuje se pouze json
formát.
Name | Typ | Description |
---|---|---|
json |
string |
SunGlare
Hodnocení, které udává, jak oslepující slunce pro řidiče.
Name | Typ | Description |
---|---|---|
calculatedVehicleHeading |
integer |
Pokud pro waypoint není uvedená hodnota nadpisu vozidla, služba vypočítá nadpis na základě umístění sousedních waypointů, pokud jsou k dispozici. |
glareIndex |
integer |
Index od 0 do 100 označující intenzitu oslnění u řidiče. Hodnota 50 a vyšší může být pro některé řidiče považována za nebezpečí a hodnota 100 značí, že řidič jede přímo na slunce a atmosférické podmínky jsou jasné, což umožňuje plnou intenzitu slunce oslepit řidiče. |
UnitType
Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v Azure Maps ve službách Počasí.
Name | Typ | 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
Předpověď srážek počasí na trase.
Name | Typ | Description |
---|---|---|
dbz |
number |
Předpokládaná intenzita srážek v dBZ (decibely vzhledem k Z) od 0,0 do 100,0. |
type |
string |
Typ srážek. Pokud by se měly vyskytnout srážky, bude to typ: "DÉŠŤ", "KROUPY", "SNÍH", "ICE" nebo "MIX". |
WeatherAlongRouteResult
Tento objekt se vrátí z úspěšného weather Along Route.
Name | Typ | Description |
---|---|---|
summary |
Krátký přehled počasí na trase. |
|
waypoints |
Data pro každý bod cesty vrácená ve stejném pořadí, v jakém je uvedeno v požadavku. |
WeatherAlongRouteSummary
Krátký přehled počasí na trase.
Name | Typ | Description |
---|---|---|
hazards |
Popis nebezpečí počasí ovlivňujícího jízdu. |
|
iconCode |
Číselná hodnota představující obrázek, který zobrazuje |
WeatherHazards
Popis nebezpečí počasí ovlivňujícího jízdu.
Name | Typ | Description |
---|---|---|
hazardDetails |
Podrobnosti o povětrnostních nebezpečích ovlivňujících cestu. |
|
maxHazardIndex |
Index závažnosti/nebezpečí.
|
WeatherNotification
Name | Typ | Description |
---|---|---|
hazardCode |
string |
Jedinečný identifikátor (nezobrazovatelný) pro každý typ nebezpečí: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, SalesforceWarning, SevereThunderstormWarning. |
hazardIndex |
Index závažnosti/nebezpečí.
|
|
shortPhrase |
string |
Zobrazitelná krátká fráze popisující předpokládané podmínky a intenzitu/typ srážek. |
type |
string |
Typ oznámení vygenerovaného k upozornění řidiče na nástup nebezpečí nebo na zvýšení intenzity nebezpečí. |
WeatherUnit
Konkrétní hodnota dané jednotky související s počasím.
Name | Typ | Description |
---|---|---|
unit |
string |
Typ jednotky pro vrácenou hodnotu. |
unitType |
Číselná hodnota ID přidružená k typu zobrazené jednotky. Lze použít k překladu jednotek. Podrobnosti najdete v Azure Maps ve službách Počasí. |
|
value |
number |
Zaokrouhlená hodnota. |
WeatherWaypoint
Name | Typ | Description |
---|---|---|
cloudCover |
integer |
Procento představující cloudové pokrytí. |
hazards |
Popis nebezpečí počasí ovlivňujícího jízdu. |
|
iconCode |
Číselná hodnota představující obrázek, který zobrazuje |
|
isDayTime |
boolean |
Určuje denní čas. True označuje "den", "false" označuje "noc". |
lightningCount |
integer |
Odhad intenzity bouřky v otevřeném měřítku. Hodnota 0 znamená, že nedochází k bouřce; Hodnoty 1 a vyšší průměry: intenzita bouřky se zvyšuje. |
notifications |
Seznam oznámení o nebezpečí počasí. |
|
precipitation |
Předpověď srážek počasí na trase. |
|
shortPhrase |
string |
Zobrazitelná krátká fráze popisující předpokládané podmínky a intenzitu/typ srážek. |
sunGlare |
Hodnocení, které udává, jak oslepující slunce pro řidiče. |
|
temperature |
Konkrétní hodnota dané jednotky související s počasím. |
|
wind |
Vrací se podrobnosti o větru, včetně rychlosti a směru. |
|
windGust |
Vrací se podrobnosti o větru, včetně rychlosti a směru. |
WindDetails
Vrací se podrobnosti o větru, včetně rychlosti a směru.
Name | Typ | Description |
---|---|---|
direction |
Směr větru |
|
speed |
Rychlost větru v zadané jednotce. |
WindDirection
Směr větru
Name | Typ | Description |
---|---|---|
degrees |
integer |
Směr větru ve stupních Azimuth, začíná na severu a pokračuje ve směru hodinových ručiček. Sever je 0 stupňů, východ 90 stupňů, jih 180 stupňů, západ 270 stupňů. Možné hodnoty 0–359. |
localizedDescription |
string |
Zkratka směru v zadaném jazyce |