Render - Get Map Tile

Service:

Maps

API Version:

2022-08-01

Służy do żądania kafelków mapy w formacie wektorowym lub rasterowym.
**

Interfejs Get Map Tiles API to żądanie HTTP GET , które umożliwia użytkownikom żądanie kafelków mapy w formatach wektorowych lub rasterowych, zwykle do zintegrowania z kontrolką mapy lub zestawem SDK. Przykładowe kafelki, których można zażądać, to Azure Maps kafelki dróg, kafelki radaru pogody w czasie rzeczywistym lub kafelki mapy utworzone przy użyciu Azure Maps Creator. Domyślnie Azure Maps używa kafelków wektorowych dla kontrolki mapy internetowej (Web SDK) i zestawu Android SDK.

GET https://atlas.microsoft.com/map/tile?api-version=2022-08-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}

With optional parameters:

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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Numer wersji interfejsu API Azure Maps. Bieżąca wersja to 2022-08-01
tilesetId	query	True	TilesetID	Zestaw kafelków to kolekcja danych rasterowych lub wektorów podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator kafelków do użycia podczas wysyłania żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu Azure Maps Creator jest generowany za pośrednictwem interfejsu API zestawu kafelków Twórca. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez Azure Maps. Na przykład microsoft.base.
x	query	True	integer int32	Współrzędna X kafelka w siatce powiększenia. Wartość musi znajdować się w zakresie [0, 2zoom -1]. Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatka kafelków .
y	query	True	integer int32	Współrzędna Y kafelka w siatce powiększenia. Wartość musi znajdować się w zakresie [0, 2zoom -1]. Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatka kafelków .
zoom	query	True	integer int32	Poziom powiększenia dla żądanego kafelka. Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatka kafelków .
language	query		string	Język, w którym powinny być zwracane wyniki wyszukiwania. Powinien być jednym z obsługiwanych tagów języka IETF, bez uwzględniania wielkości liter. Gdy dane w określonym języku nie są dostępne dla określonego pola, używany jest język domyślny. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane języki .
tileSize	query		MapTileSize	Rozmiar zwracanego kafelka mapy w pikselach.
timeStamp	query		string date-time	Żądana data i godzina żądanego kafelka. Ten parametr musi być określony w standardowym formacie daty i godziny (np. 2019-11-14T16:03:00-08:00), zgodnie z definicją iso 8601. Ten parametr jest obsługiwany tylko wtedy, gdy parametr tilesetId jest ustawiony na jedną z poniższych wartości. microsoft.weather.infrared.main: Udostępniamy kafelki do 3 godzin w przeszłości. Kafelki są dostępne w 10-minutowych odstępach czasu. Zaokrąglamy wartość znacznika czasu do najbliższego 10-minutowego przedziału czasu. microsoft.weather.radar.main: Dostarczamy kafelki do 1,5 godzin w ciągu ostatnich i do 2 godzin w przyszłości. Kafelki są dostępne w 5-minutowych odstępach czasu. Zaokrąglamy wartość znacznika czasu do najbliższego 5-minutowego przedziału czasu.
view	query		LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie poprawnych map dla określonego kraju/regionu dla regionów spornych geopolitycznie. Różne kraje/regiony mają różne widoki takich regionów, a parametr View umożliwia aplikacji zgodność z widokiem wymaganym przez kraj/region, który aplikacja będzie obsługiwać. Domyślnie parametr Widok jest ustawiony na "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru View dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z tymi dotyczącymi mapowania, kraju/regionu, w którym są dostępne mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zapoznaj się z tematem Obsługiwane widoki i zobacz dostępne widoki.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-id		string	Określa, które konto jest przeznaczone do użycia w połączeniu z modelem zabezpieczeń Tożsamość Microsoft Entra. Reprezentuje unikatowy identyfikator konta Azure Maps i można go pobrać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby użyć zabezpieczeń Tożsamość Microsoft Entra w usłudze Azure Maps, zobacz następujące artykuły, aby uzyskać wskazówki.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	object	Kafelek zwrócony z pomyślnego wywołania interfejsu API. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	Wystąpił nieoczekiwany błąd. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Zabezpieczenia

AADToken

Są to przepływy protokołu OAuth 2.0 Microsoft Entra. W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

• Ta definicja zabezpieczeń wymaga użycia nagłówkax-ms-client-id, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje Tożsamość Microsoft Entra. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.

• Aby uzyskać więcej informacji na temat Platforma tożsamości Microsoft, zobacz omówienie Platforma tożsamości Microsoft.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Jest to klucz wspólny aprowizowany podczas tworzenia zasobu Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.

W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu do serwera Azure Maps interfejsów API REST, w których ten klucz może być bezpiecznie przechowywany.

Type: apiKey
In: header

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji listy sygnatur dostępu współdzielonego w zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.

Przy użyciu tego tokenu każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token sygnatury dostępu współdzielonego może służyć do umożliwienia aplikacjom kontrolowania dostępu w bardziej bezpieczny sposób niż klucz wspólny.

W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie konta mapy w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SYGNATURy dostępu współdzielonego.

Type: apiKey
In: header

Przykłady

Successful Tile Request

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Response Body

"binary image string"

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
LocalizedMapView	Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie prawidłowych map dla określonego kraju/regionu dla spornych geopolitycznie regionów. Różne kraje/regiony mają różne widoki takich regionów, a parametr Wyświetl umożliwia aplikacji zachowanie zgodności z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania, kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane widoki .
MapTileSize	Rozmiar zwracanego kafelka mapy w pikselach.
TilesetID	Zestaw kafelków jest kolekcją danych rastrowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator tilesetId do użycia podczas tworzenia żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu Azure Maps Creator jest generowany za pośrednictwem interfejsu API zestawu kafelków Twórca. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez Azure Maps. Na przykład microsoft.base.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt error.

LocalizedMapView

Parametr View (nazywany również parametrem "region użytkownika") umożliwia wyświetlanie prawidłowych map dla określonego kraju/regionu dla spornych geopolitycznie regionów. Różne kraje/regiony mają różne widoki takich regionów, a parametr Wyświetl umożliwia aplikacji zachowanie zgodności z widokiem wymaganym przez kraj/region, który będzie obsługiwać aplikacja. Domyślnie parametr Widok jest ustawiony na wartość "Unified", nawet jeśli nie zdefiniowano go w żądaniu. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Alternatywnie możesz ustawić opcję "View=Auto", która zwróci dane mapy na podstawie adresu IP żądania. Parametr View w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania, kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem Azure Maps. Przykład: view=IN.

Aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki, zapoznaj się z tematem Obsługiwane widoki .

Nazwa	Typ	Opis
AE	string	Zjednoczone Emiraty Arabskie (widok arabski)
AR	string	Argentyna (widok argentyński)
Auto	string	Zwróć dane mapy na podstawie adresu IP żądania.
BH	string	Bahrajn (widok arabski)
IN	string	Indie (Widok indyjski)
IQ	string	Irak (widok arabski)
JO	string	Jordania (widok arabski)
KW	string	Kuwejt (widok arabski)
LB	string	Liban (widok arabski)
MA	string	Maroko (widok marokański)
OM	string	Oman (widok arabski)
PK	string	Pakistan (Pakistani View)
PS	string	Autonomia Palestyńska (widok arabski)
QA	string	Katar (widok arabski)
SA	string	Arabia Saudyjska (widok arabski)
SY	string	Syria (widok arabski)
Unified	string	Ujednolicony widok (inne)
YE	string	Jemen (widok arabski)

MapTileSize

Rozmiar zwracanego kafelka mapy w pikselach.

Nazwa	Typ	Opis
256	string	Zwróć kafelek 256 o 256 pikseli.
512	string	Zwróć kafelek 512 o 512 pikseli.

TilesetID

Zestaw kafelków jest kolekcją danych rastrowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na wstępnie ustawionych poziomach powiększenia. Każdy zestaw kafelków ma identyfikator tilesetId do użycia podczas tworzenia żądań. Element tilesetId dla zestawów kafelków utworzonych przy użyciu Azure Maps Creator jest generowany za pośrednictwem interfejsu API zestawu kafelków Twórca. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez Azure Maps. Na przykład microsoft.base.

Nazwa	Typ	Opis
microsoft.base	string	Mapa podstawowa to standardowa mapa, która wyświetla drogi, naturalne i sztuczne cechy wraz z etykietami dla tych cech w kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.darkgrey	string	Wszystkie warstwy z naszym ciemnoszarym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.hybrid	string	Wyświetla dane dotyczące dróg, granic i etykiet w kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.hybrid.darkgrey	string	Dane dotyczące dróg, granic i etykiet w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.hybrid.road	string	Dane dotyczące dróg, granic i etykiet w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.labels	string	Wyświetla etykiety dróg, naturalnych i sztucznych cech w kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: vector (pbf).
microsoft.base.labels.darkgrey	string	Oznacz dane etykietami w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.labels.road	string	Oznacz dane etykietami w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.base.road	string	Wszystkie warstwy z naszym głównym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: raster (png).
microsoft.imagery	string	Połączenie zdjęć satelitarnych i lotniczych. Dostępna tylko w jednostkach SKU cen S1. Obsługuje poziomy powiększenia od 1 do 19. Format: raster (jpeg).
microsoft.terra.main	string	Cieniowana ulga i warstwy terra. Obsługuje poziomy powiększenia od 0 do 6. Format: raster (png).
microsoft.traffic.absolute	string	bezwzględne kafelki ruchu w wektorze
microsoft.traffic.absolute.main	string	bezwzględne kafelki ruchu w raster w naszym głównym stylu.
microsoft.traffic.delay	string	kafelki ruchu w wektorze
microsoft.traffic.delay.main	string	kafelki ruchu w rasterze w naszym głównym stylu
microsoft.traffic.incident	string	kafelki zdarzeń w wektorze
microsoft.traffic.reduced.main	string	zmniejszenie liczby kafelków ruchu w rasterze w naszym głównym stylu
microsoft.traffic.relative	string	kafelki ruchu względnego w wektorze
microsoft.traffic.relative.dark	string	względne kafelki ruchu w raster w naszym ciemnym stylu.
microsoft.traffic.relative.main	string	względne kafelki ruchu w raster w naszym głównym stylu.
microsoft.weather.infrared.main	string	Kafelki podczerwone w pogodzie. Najnowsze zdjęcia satelitarne podczerwieni pokazują chmury według ich temperatury. Zobacz informacje o zasięgu dla usługi Azure Maps Weather Service. Aby dowiedzieć się więcej na temat zwracanych danych satelickich, zobacz Pojęcia dotyczące pogody. Obsługuje poziomy powiększenia od 0 do 15. Format: raster (png).
microsoft.weather.radar.main	string	Kafelki radaru pogodowego. Najnowsze obrazy radarów pogodowych, w tym obszary deszczu, śniegu, lodu i mieszanych warunków. Zobacz informacje o zasięgu dla usługi Azure Maps Weather Service. Aby dowiedzieć się więcej na temat danych radarowych, zobacz Pojęcia dotyczące pogody. Obsługuje poziomy powiększenia od 0 do 15. Format: raster (png).