Render - Get Map Tile
Slouží k vyžádání dlaždic mapy ve vektorovém nebo rastrovém formátu.
**
Rozhraní Get Map Tiles
API je požadavek HTTP GET
, který umožňuje uživatelům vyžadovat dlaždice mapování ve vektorových nebo rastrových formátech, které se obvykle integruje do ovládacího prvku mapy nebo sady SDK. Mezi ukázkové dlaždice, které se dají vyžádat, patří Azure Maps dlaždice silnic, dlaždice meteorologické radary v reálném čase nebo dlaždice map vytvořené pomocí Azure Maps Creatoru. Ve výchozím nastavení používá Azure Maps vektorové dlaždice pro ovládací prvek webové mapy (Webová sada SDK) a sadu Android SDK.
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-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 |
---|---|---|---|---|
api-version
|
query | True |
string |
Číslo verze rozhraní API Azure Maps. Aktuální verze je 1. 8. 2022 |
tileset
|
query | True |
Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id tileetId pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic předdefinované Azure Maps jsou uvedené 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, 2 Podrobnosti najdete v tématu Úrovně přiblížení a Mřížka dlaždic . |
y
|
query | True |
integer int32 |
Souřadnice Y dlaždice v mřížce lupy. Hodnota musí být v rozsahu [0, 2 Podrobnosti najdete v tématu Úrovně přiblížení a Mřížka 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řížka dlaždic . |
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 . |
|
tile
|
query |
Velikost vrácené dlaždice mapy v pixelech |
||
time
|
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) podle definice iso 8601. Tento parametr je podporován pouze v případě, že je parametr tileetId nastavený na jednu z následujících hodnot.
|
|
view
|
query |
Parametr View (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení takových oblastí a parametr View umožňuje, aby aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified", i když jste ho v požadavku nedefinovali. Je vaší zodpovědností určit umístění uživatelů a pak pro toto umístění správně nastavit parametr View. Případně máte možnost nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr View v Azure Maps musí být použit v souladu s platnými zákony, včetně těch, které se týkají mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps jsou dostupné. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
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 Azure Maps roviny správy. Pokud chcete použít zabezpečení Microsoft Entra ID v Azure Maps pokyny najdete v následujících článcích. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
object |
Dlaždice vrácená po úspěšném volání rozhraní API Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string |
Other Status Codes |
Došlo k neočekávané chybě. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
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řizuje při vytváření Azure Maps prostředku 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 klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.
U veřejně vystavených aplikací doporučujeme používat přístup mezi servery Azure Maps rozhraní REST API, ve kterých lze tento klíč bezpečně uložit.
Type:
apiKey
In:
header
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
Successful Tile Request
Sample Request
GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Sample Response
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Localized |
Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
Map |
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 s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id sady dlaždic pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic připravené k použití, které Azure Maps, jsou uvedené níže. Například microsoft.base. |
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
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
LocalizedMapView
Parametr Zobrazení (označovaný také jako parametr "oblast uživatele") umožňuje zobrazit správné mapy pro určitou zemi nebo oblast pro geopoliticky sporné oblasti. Různé země nebo oblasti mají různá zobrazení těchto oblastí a parametr Zobrazení umožňuje, aby vaše aplikace splňovala zobrazení vyžadované zemí nebo oblastí, které bude vaše aplikace obsluhovat. Ve výchozím nastavení je parametr View nastavený na "Unified" i v případě, že jste ho v požadavku nedefinovali. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Alternativně můžete nastavit View=Auto, která vrátí mapová data na základě IP adresy požadavku. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps. Příklad: view=IN.
Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení.
Name | Typ | Description |
---|---|---|
AE |
string |
Spojené arabské emiráty (arabské zobrazení) |
AR |
string |
Argentina (argentinský pohled) |
Auto |
string |
Vrátí mapová data na základě IP adresy požadavku. |
BH |
string |
Bahrajn (arabské zobrazení) |
IN |
string |
Indie (indické zobrazení) |
IQ |
string |
Irák (arabské zobrazení) |
JO |
string |
Jordánsko (arabské zobrazení) |
KW |
string |
Kuvajt (arabské zobrazení) |
LB |
string |
Libanon (arabské zobrazení) |
MA |
string |
Maroko (marocké zobrazení) |
OM |
string |
Omán (arabské zobrazení) |
PK |
string |
Pákistán (pákistánské zobrazení) |
PS |
string |
Palestinská samospráva (arabské zobrazení) |
QA |
string |
Katar (arabské zobrazení) |
SA |
string |
Saúdská Arábie (arabské zobrazení) |
SY |
string |
Sýrie (arabské zobrazení) |
Unified |
string |
Sjednocené zobrazení (ostatní) |
YE |
string |
Jemen (arabské zobrazení) |
MapTileSize
Velikost vrácené dlaždice mapy v pixelech.
Name | Typ | Description |
---|---|---|
256 |
string |
Vrátí dlaždici o velikosti 256 × 256 pixelů. |
512 |
string |
Vrátí dlaždici o velikosti 512 × 512 pixelů. |
TilesetID
Sada dlaždic je kolekce rastrových nebo vektorových dat rozdělených do jednotné mřížky čtvercových dlaždic s přednastavenými úrovněmi přiblížení. Každá sada dlaždic má id sady dlaždic , které se použije při vytváření požadavků. Id sady dlaždic pro sady dlaždic vytvořené pomocí Azure Maps Creatoru se generuje prostřednictvím rozhraní API sady dlaždic Create. Sady dlaždic připravené k použití, které Azure Maps, jsou uvedené níže. Například microsoft.base.
Name | Typ | Description |
---|---|---|
microsoft.base |
string |
Základní mapa je standardní mapa, která zobrazuje cesty, přirozené a umělé prvky spolu s popisky těchto prvků ve vektorové dlaždici. Podporuje úrovně přiblížení 0 až 22. Formát: vektor (pbf). |
microsoft.base.darkgrey |
string |
Všechny vrstvy v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png). |
microsoft.base.hybrid |
string |
Zobrazí data cest, hranic a popisků v dlaždici vektoru. Podporuje úrovně přiblížení 0 až 22. Formát: vektor (pbf). |
microsoft.base.hybrid.darkgrey |
string |
Data cest, hranic a popisků v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png). |
microsoft.base.hybrid.road |
string |
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.labels |
string |
Zobrazí popisky cest, přírodních a umělých prvků ve vektorové dlaždici. Podporuje úrovně přiblížení 0 až 22. Formát: vektor (pbf). |
microsoft.base.labels.darkgrey |
string |
Označte data v našem tmavě šedém stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png). |
microsoft.base.labels.road |
string |
Označte data v našem hlavním stylu. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png). |
microsoft.base.road |
string |
Všechny vrstvy s naším hlavním stylem. Podporuje úrovně přiblížení 0 až 22. Formát: rastr (png). |
microsoft.imagery |
string |
Kombinace satelitních a leteckých snímků. K dispozici pouze v cenové SKU S1. Podporuje úrovně přiblížení 1 až 19. Formát: rastr (jpeg). |
microsoft.terra.main |
string |
Stínované reliéfní a terra vrstvy. Podporuje úrovně přiblížení 0 až 6. Formát: rastr (png). |
microsoft.traffic.absolute |
string |
dlaždice absolutního provozu ve vektoru |
microsoft.traffic.absolute.main |
string |
absolutní provoz dlaždice v rastru v našem hlavním stylu. |
microsoft.traffic.delay |
string |
dlaždice provozu ve vektoru |
microsoft.traffic.delay.main |
string |
traffic tiles in raster in our main style |
microsoft.traffic.incident |
string |
Dlaždice incidentů ve vektoru |
microsoft.traffic.reduced.main |
string |
dlaždice s omezeným provozem v rastru v našem hlavním stylu |
microsoft.traffic.relative |
string |
dlaždice relativního provozu ve vektoru |
microsoft.traffic.relative.dark |
string |
dlaždice s relativním provozem v rastru v našem tmavém stylu. |
microsoft.traffic.relative.main |
string |
dlaždice relativního provozu v rastru v našem hlavním stylu. |
microsoft.weather.infrared.main |
string |
Infračervené dlaždice s počasím. Nejnovější infračervené satelitní snímky ukazují mraky podle jejich teploty. Projděte si informace o pokrytí služby Azure Maps Weather. Další informace o vrácených satelitních datech najdete v tématu Koncepty počasí. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png). |
microsoft.weather.radar.main |
string |
Dlaždice meteorologické radary. Nejnovější snímky meteorologické radary, včetně oblastí s deštěm, sněhem, ledem a smíšenými podmínkami. Projděte si informace o pokrytí služby Azure Maps Weather. Další informace o radarových datech najdete v tématu Koncepty počasí. Podporuje úrovně přiblížení 0 až 15. Formát: rastr (png). |