Traffic - Get Traffic Incident Viewport
Slouží k získání právních a technických informací pro zobrazení.
Rozhraní Traffic Incident Viewport
API je požadavek HTTP GET
, který vrací právní a technické informace pro zobrazení popsané v požadavku. Klientské aplikace by ho měly volat pokaždé, když se změní zobrazení (například přiblížením, posouváním, přechodem na místo nebo zobrazením trasy). Požadavek by měl obsahovat ohraničující rámeček a úroveň přiblížení zobrazení, jehož informace jsou potřeba. Vrácení bude obsahovat informace o verzi mapy a také aktuální ID modelu provozu a ID autorských práv. ID modelu provozu vrácené popisem zobrazení se používá v jiných rozhraních API k načtení informací o posledním provozu pro další zpracování.
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}©right={copyright}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
format
|
path | True |
Požadovaný formát odpovědi. Hodnota může být json nebo xml. |
|
api-version
|
query | True |
string |
Číslo verze rozhraní API služby Azure Maps |
boundingbox
|
query | True |
number[] |
Ohraničující rámeček zobrazení mapy v EPSG900913 projekci. Je |
boundingzoom
|
query | True |
integer int32 |
Úroveň přiblížení zobrazení mapy Slouží k určení, jestli je možné zobrazení přiblížit. |
overviewbox
|
query | True |
number[] |
Ohraničující rámeček přehledové mapy v EPSG900913 projekci. |
overviewzoom
|
query | True |
integer int32 |
Úroveň přiblížení přehledové mapy Pokud minimapa neexistuje, použijte stejnou úroveň přiblížení jako boundingZoom. |
copyright
|
query |
boolean |
Určuje, jaké informace o autorských právech se mají vrátit. Když true text je vrácen; pokud je vrácen pouze index autorských práv. |
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 dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Microsoft Entra ID ve službě Azure Maps 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 toky Microsoft Entra 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 rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. 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 rozhraním REST API služby Azure Maps.
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í prostředku Azure Maps, 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 webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
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 vytvoření účtu Azure Maps na webu 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žít pro přístup k rozhraním REST API služby Azure Maps přístup k důvěrným klientským aplikacím , aby se váš klíč mohl bezpečně uložit.
Typ:
apiKey
V:
query
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy 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.
Typ:
apiKey
V:
header
Příklady
Request traffic incident information for the selected viewport
Ukázkový požadavek
GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2©right=True
Ukázková odpověď
{
"viewpResp": {
"trafficState": {
"@trafficAge": 18895,
"@trafficModelId": "1504808593298"
},
"copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis",
"@version": "1.0.51-mascoma",
"@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
}
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě. |
Error |
Odpověď na chybu |
Response |
Požadovaný formát odpovědi. Hodnota může být json nebo xml. |
Traffic |
Tento objekt se vrátí z úspěšného volání zobrazení dopravního incidentu. |
Traffic |
Informace o stavu provozu |
Viewp |
Objekt Viewport Response |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Další typ informací. |
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
Odpověď na chybu
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
ResponseFormat
Požadovaný formát odpovědi. Hodnota může být json nebo xml.
Name | Typ | Description |
---|---|---|
json |
string |
|
xml |
string |
TrafficIncidentViewport
Tento objekt se vrátí z úspěšného volání zobrazení dopravního incidentu.
Name | Typ | Description |
---|---|---|
viewpResp |
Objekt Viewport Response |
TrafficState
Informace o stavu provozu
Name | Typ | Description |
---|---|---|
@trafficAge |
integer |
Uplynulý čas (v sekundách) od vytvoření ID modelu provozu |
@trafficModelId |
string |
Jedinečné ID s názvem ID modelu provozu se používá při volání služeb dopravního incidentu. Umožňuje získávat informace z konkrétních aktualizací provozu. ID modelu provozu se aktualizuje každou minutu a je platné dvě minuty, než vyprší jeho časový limit. |
ViewpResp
Objekt Viewport Response
Name | Typ | Description |
---|---|---|
@maps |
string |
Označuje interní názvy zprostředkovatele dat pro mapová data použitá v zobrazení. Pro použití s dotazy podpory. |
@version |
string |
Označuje verzi softwaru použitou k vygenerování informací. Pro použití s dotazy podpory. |
copyrightIds |
string |
Pokud je hodnota parametru copyright pravdivá, obsahuje úplný text informací o autorských právech, které se musí zobrazit s dlaždicemi v oblasti zobrazení. |
trafficState |
Informace o stavu provozu |