Render - Get Map Tile

Služba:

Maps

Verze rozhraní API:

2024-04-01

Slouží k vyžádání mapových dlaždic ve vektorovém nebo rastrovém formátu.
Rozhraní Get Map Tiles API umožňuje uživatelům požadovat mapové dlaždice ve vektorových nebo rastrových formátech, obvykle pro integraci do mapového ovládacího prvku nebo sady SDK. Podporované typy dlaždic zahrnují dlaždice silnic Azure Maps a dlaždice Weather Radar v reálném čase. Ve výchozím nastavení používá Azure Maps Web SDK vektorové dlaždice pro ovládání své webové mapy.

Important

Při použití Get Map Tile API musíte také volat Get Map Attribution API, abyste získali požadovaný text o atribucí mapových dat.

Vrácená atribuce musí být zobrazena všude tam, kde jsou dlaždice získané z Get Map Tile vykreslovány, včetně třetích stran pro ovládání map nebo vlastních renderovacích implementací.

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

S volitelnými parametry:

GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Hostname služby Azure Maps. Použijte https://atlas.microsoft.com pro Azure veřejný cloud. Pro cílení na konkrétní Azure Maps geografii nebo suverénní cloud viz Azure Maps geografický rozsah.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
tilesetId	query	True	TilesetID	Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic na přednastavených úrovních přiblížení. Každá sada dlaždic má tilesetId použít při provádění požadavků. Připravené tilesety dodané Azure Maps jsou uvedeny níže. Například microsoft.base.
x	query	True	integer (int32)	Souřadnice X dlaždice v mřížce lupy Hodnota musí být v rozsahu [0, 2zoom -1]. Podrobnosti najdete v tématu úrovně přiblížení a mřížky dlaždic.
y	query	True	integer (int32)	Souřadnice Y dlaždice v mřížce lupy Hodnota musí být v rozsahu [0, 2zoom -1]. Podrobnosti najdete v tématu úrovně přiblížení a mřížky dlaždic.
zoom	query	True	integer (int32)	Úroveň přiblížení požadované dlaždice Podrobnosti najdete v tématu úrovně přiblížení a mřížky dlaždic.
language	query		string	Jazyk, ve kterém mají být vráceny výsledky hledání. Měla 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 dostupná, použije se výchozí jazyk. Podrobnosti najdete v podporovaných jazycích.
tileSize	query		MapTileSize	Velikost vrácené dlaždice mapy v pixelech.
timeStamp	query		string (date-time)	Požadované datum a čas požadované dlaždice. Tento parametr musí být zadán ve standardním formátu data a času (např. 2019-11-14T16:03:00-08:00), jak je definováno ISO 8601. Tento parametr se podporuje jenom v případě, že je parametr tilesetId nastavený na jednu z níže uvedených hodnot. microsoft.weather.infrared.main: Poskytujeme dlaždice do 3 hodin v minulosti. Dlaždice jsou k dispozici v 10minutových intervalech. Hodnotu timeStamp zaokrouhlíme na nejbližší 10minutový časový rámec. microsoft.weather.radar.main: Poskytujeme dlaždice až 1,5 hodiny v minulosti a až 2 hodiny v budoucnu. Dlaždice jsou k dispozici v 5minutových intervalech. Hodnotu timeStamp zaokrouhlíme na nejbližší 5minutový časový rámec.
view	query		LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazit v Azure Maps musí být používán v souladu s platnými zákony, včetně těch týkajících se mapování, země/regionu, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterým máte oprávnění přistupovat prostřednictvím Azure Maps, zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-id		string	Označuje účet určený pro použití s bezpečnostním modelem Microsoft Entra ID. Toto jedinečné ID pro účet Azure Maps lze získat z API účtu Azure Maps management plane. Pro více informací o používání Microsoft Entra ID bezpečnosti v Azure Maps viz Spravovat autentizaci v Azure Maps.

Odpovědi

Name	Typ	Description
200 OK	string	Požadavek byl úspěšný. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Zabezpečení

AadToken

Jsou to Microsoft Entra OAuth 2.0 Flows. V kombinaci s Azure řízením přístupu založeného na rolích lze použít k řízení přístupu k Azure Maps REST API. Role Azure kontroly přístupu se používají k určení přístupu k jednomu nebo více účtům nebo podzdrojů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 složené 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 koncepty ověřování . Stručně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a rozsahy.

Note

• Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení, ke kterému prostředku Azure Maps aplikace žádá o přístup. To lze získat z rozhraní API pro správu Maps.
• Authorization URL je specifická pro instanci veřejného cloudu Azure. Suverénní cloudy mají unikátní autorizační URL a konfigurace Microsoft Entra ID.
• Řízení přístupu na základě role 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

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.

Díky tomuto klíči má každá aplikace přístup ke všem rozhraní REST API. Jinými slovy, tento klíč lze použít jako hlavní klíč v účtu, ve který jsou vydány.

U veřejně vystavených aplikací doporučujeme používat důvěrných klientských aplikací přístup k rozhraním REST API služby Azure Maps, aby bylo možné klíč bezpečně uložit.

Typ: apiKey
V: header

SAS Token

Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace Vypsat SAS v prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad SDK Azure 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 Azure a jemně odstupňované řízení vypršení platnosti, rychlosti a oblastí použití pro konkrétní token. Jinými slovy, token SAS lze 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ů na prostředku účtu Map omezit zneužití vykreslování a pravidelně obnovovat token SAS.

Typ: apiKey
V: header

Příklady

Successful Tile Request

Ukázkový požadavek

HTTP

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

Ukázková odpověď

Stavový kód:

200

Content-Type: application/vnd.mapbox-vector-tile

"binary image string"

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)
LocalizedMapView	Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazit v Azure Maps musí být používán v souladu s platnými zákony, včetně těch týkajících se mapování, země/regionu, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterým máte oprávnění přistupovat prostřednictvím Azure Maps, zpřístupněn. Příklad: view=IN. Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.
MapTileSize	Velikost vrácené dlaždice mapy v pixelech.
TilesetID	Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic na přednastavených úrovních přiblížení. Každá sada dlaždic má tilesetId použít při provádění požadavků. Připravené tilesety dodané Azure Maps jsou uvedeny níže. Například microsoft.base.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích. (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

LocalizedMapView

Výčet

Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopolitické sporné oblasti. Různé země/oblasti mají různá zobrazení těchto oblastí a parametr View umožňuje vaší aplikaci dodržovat zobrazení vyžadované zemí nebo oblastí, kterou bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na Sjednocený, i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Alternativně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazit v Azure Maps musí být používán v souladu s platnými zákony, včetně těch týkajících se mapování, země/regionu, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterým máte oprávnění přistupovat prostřednictvím Azure Maps, zpřístupněn. Příklad: view=IN.

Podrobnosti a dostupné zobrazení najdete v podporovaných zobrazeních.

Hodnota	Description
AE	Spojené arabské emiráty (zobrazení arabštiny)
AR	Argentina (argentinský pohled)
BH	Arabština (zobrazení arabštiny)
IN	Indie (indické zobrazení)
IQ	Irák (arabské zobrazení)
JO	Jordánsko (arabské zobrazení)
KW	Kuvajt (arabské zobrazení)
LB	Libanon (zobrazení arabštiny)
MA	Maroko (marocký pohled)
OM	Omán (zobrazení arabštiny)
PK	Pákistán (pákistánské zobrazení)
PS	Palestinská autorita (arabské zobrazení)
QA	Katar (zobrazení arabštiny)
SA	Saúdská Arábie (zobrazení arabštiny)
SY	Sýrie (zobrazení arabštiny)
US	Spojené státy americké
YE	Jemen (arabské zobrazení)
Auto	Vrátí data mapy na základě IP adresy požadavku.
Unified	Jednotné zobrazení (ostatní)

MapTileSize

Výčet

Velikost vrácené dlaždice mapy v pixelech.

Hodnota	Description
256	Vrátí dlaždici o velikosti 256 × 256 pixelů.
512	Vrátí dlaždici o velikosti 512 × 512 pixelů.

TilesetID

Výčet

Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic na přednastavených úrovních přiblížení. Každá sada dlaždic má tilesetId použít při provádění požadavků. Připravené tilesety dodané Azure Maps jsou uvedeny níže. Například microsoft.base.

Hodnota	Description
microsoft.base	Základní mapa je standardní mapa, která zobrazuje cesty, přirozené a umělé funkce spolu s popisky těchto funkcí ve vektorové dlaždici. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.base.labels	Zobrazí popisky pro silnice, přirozené a umělé funkce v dlaždici vektoru. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.base.hybrid	Zobrazí data cest, hranic a popisků v dlaždici vektoru. Podporuje úrovně přiblížení 0 až 22. Formát: vector (pbf).
microsoft.terra.main	Stínované vrstvy a vrstvy terra. Podporuje úrovně přiblížení 0 až 6. Formát: rastr (png).
microsoft.base.road	Všechny vrstvy s naším hlavním stylem. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.darkgrey	Všechny vrstvy s naším tmavě šedým stylem. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.labels.road	Označení dat v našem hlavním stylu Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.labels.darkgrey	Označte data v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.hybrid.road	Data cest, hranic a popisků v našem hlavním stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.base.hybrid.darkgrey	Údaje o silnicích, hranicích a značkách v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png).
microsoft.imagery	Kombinace satelitních nebo leteckých snímků. K dispozici pouze v cenových cenách S1 a G2. Podporuje úrovně přiblížení 1 až 19. Formát: rastr (png).
microsoft.weather.radar.main	Radarové dlaždice počasí. Nejnovější snímky radaru počasí včetně oblastí deště, sněhu, ledu a smíšených podmínek. Pro více informací o pokrytí meteorologických služeb Azure Maps viz Azure Maps pokrytí meteorologických služeb. Pro více informací o radarových datech viz Meteorologické služby v Azure Maps. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png).
microsoft.weather.infrared.main	Infračervené dlaždice počasí. Nejnovější infračervené satelitní snímky ukazují mraky podle jejich teploty. Pro více informací viz Azure Maps pokrytí meteorologických služeb. Pro více informací o satelitních datech viz Meteorologické služby v Azure Maps. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png).
microsoft.traffic.absolute	dlaždice absolutního provozu ve vektoru
microsoft.traffic.absolute.main	dlaždice s absolutním provozem v našem hlavním stylu.
microsoft.traffic.relative	dlaždice relativního provozu ve vektoru
microsoft.traffic.relative.main	dlaždice relativního provozu v rasteru v našem hlavním stylu.
microsoft.traffic.relative.dark	dlaždice relativního provozu v rastru v našem tmavém stylu.
microsoft.traffic.delay	dlaždice provozu ve vektoru
microsoft.traffic.delay.main	dlaždice provozu v rasteru v našem hlavním stylu
microsoft.traffic.reduced.main	zmenšené dlaždice provozu v rasteru v našem hlavním stylu
microsoft.traffic.incident	Dlaždice incidentů ve vektoru