Render - Get Map Tile
Służy do żądania kafelków mapy w formacie wektorowym lub rastrowym.
Interfejs Get Map Tiles API umożliwia użytkownikom żądanie kafelków mapy w formacie wektorowym lub rastrowym, zwykle w celu integracji z kontrolką mapy lub zestawem SDK. Obsługiwane typy kafelków obejmują kafelki dróg Azure Maps i kafelki radaru pogodowego w czasie rzeczywistym. Domyślnie zestaw Azure Maps Web SDK używa kafelków wektorowych do renderowania kontrolki mapy internetowej.
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-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 usługi Azure Maps. aktualna wersja to 2024-04-01. |
|
tileset
|
query | True |
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez usługę Azure Maps. Na przykład microsoft.base. |
|
|
x
|
query | True |
integer (int32) |
Współrzędna X kafelka na siatce powiększenia. Wartość musi być w zakresie [0, 2 Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatk a kafelków. |
|
y
|
query | True |
integer (int32) |
Współrzędna Y kafelka w siatce powiększenia. Wartość musi być w zakresie [0, 2 Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatk a kafelków. |
|
zoom
|
query | True |
integer (int32) |
Poziom powiększenia dla żądanego kafelka. Aby uzyskać szczegółowe informacje, zobacz Poziomy powiększenia i Siatk a 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. Jeśli 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. |
|
|
tile
|
query |
Rozmiar zwróconego kafelka mapy w pikselach. |
||
|
time
|
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.
|
|
|
view
|
query |
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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
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" Nagłówki Content-Type: string |
| Other Status Codes |
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 Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera 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.
Notatki
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.
Authorization URL jest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu Web SDK usługi Azure Maps umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia zasobów usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Za pomocą 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 serwer-serwer interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.
Typ:
apiKey
W:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi 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 SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Successful Tile Request
Przykładowe żądanie
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22
Przykładowa odpowiedź
Content-Type: application/vnd.mapbox-vector-tile
"binary image string"
Definicje
| Nazwa | Opis |
|---|---|
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Odpowiedź na błąd |
|
Localized |
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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN. Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki. |
|
Map |
Rozmiar zwróconego kafelka mapy w pikselach. |
| TilesetID |
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez usługę 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 |
Dodatkowe informacje o błędzie. |
|
| code |
string |
Kod błędu. |
| details |
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 |
Obiekt błędu. |
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 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 usłudze 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 usługi Azure Maps. Przykład: view=IN.
Aby uzyskać szczegółowe informacje, zobacz Obsługiwane widoki, aby uzyskać szczegółowe informacje i wyświetlić dostępne widoki.
| Wartość | Opis |
|---|---|
| AE |
Zjednoczone Emiraty Arabskie (widok arabski) |
| AR |
Argentyna (Widok argentyński) |
| BH |
Bahrajn (widok arabski) |
| IN |
Indie (Widok indyjski) |
| IQ |
Irak (widok arabski) |
| JO |
Jordania (widok arabski) |
| KW |
Kuwejt (widok arabski) |
| LB |
Liban (widok arabski) |
| MA |
Maroko (widok marokański) |
| OM |
Oman (widok arabski) |
| PK |
Pakistan (Pakistański Punkt Widzenia) |
| PS |
Autonomia Palestyńska (widok arabski) |
| QA |
Katar (widok arabski) |
| SA |
Arabia Saudyjska (widok arabski) |
| SY |
Syria (widok arabski) |
| US |
Stany Zjednoczone Ameryki |
| YE |
Jemen (widok arabski) |
| Auto |
Zwróć dane mapy na podstawie adresu IP żądania. |
| Unified |
Ujednolicony widok (inne) |
MapTileSize
Rozmiar zwróconego kafelka mapy w pikselach.
| Wartość | Opis |
|---|---|
| 256 |
Zwróć kafelek 256 o 256 pikseli. |
| 512 |
Zwróć kafelek 512 o 512 pikseli. |
TilesetID
Zestaw kafelków to kolekcja danych rasterowych lub wektorowych podzielonych na jednolitą siatkę kafelków kwadratowych na ustawionych poziomach powiększenia. Każdy zestaw kafelków ma kafelkówetId do użycia podczas wprowadzania żądań. Poniżej wymieniono gotowe do użycia zestawy kafelków dostarczone przez usługę Azure Maps. Na przykład microsoft.base.
| Wartość | Opis |
|---|---|
| microsoft.base |
Mapa podstawowa to standardowa mapa przedstawiająca drogi, naturalne i sztuczne funkcje wraz z etykietami dla tych funkcji na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: wektorowy (pbf). |
| microsoft.base.labels |
Wyświetla etykiety dla dróg, naturalnych i sztucznych cech na kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: wektorowy (pbf). |
| microsoft.base.hybrid |
Wyświetla dane dróg, granic i etykiet w kafelku wektorowym. Obsługuje poziomy powiększenia od 0 do 22. Format: wektorowy (pbf). |
| microsoft.terra.main |
Cieniowana ulga i warstwy terra. Obsługuje poziomy powiększenia od 0 do 6. Format: rastrowy (png). |
| microsoft.base.road |
Wszystkie warstwy z naszym głównym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.darkgrey |
Wszystkie warstwy z naszym ciemnoszarym stylem. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.labels.road |
Oznacz dane w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.labels.darkgrey |
Oznacz dane w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.hybrid.road |
Dane dotyczące dróg, granic i etykiet w naszym głównym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.base.hybrid.darkgrey |
Dane dotyczące dróg, granic i etykiet w naszym ciemnoszarym stylu. Obsługuje poziomy powiększenia od 0 do 22. Format: rastrowy (png). |
| microsoft.imagery |
Połączenie zdjęć satelitarnych lub lotniczych. Dostępne tylko w jednostkach SKU cenowych S1 i G2. Obsługuje poziomy powiększenia od 1 do 19. Format: rastrowy (png). |
| microsoft.weather.radar.main |
Kafelki radaru pogodowego. Najnowsze obrazy radarów pogodowych, w tym obszary deszczu, śniegu, lodu i mieszanych warunków. Aby uzyskać więcej informacji na temat zasięgu usługi Pogoda Azure Maps, zobacz Zasięg usług pogodowych Azure Maps. Aby uzyskać więcej informacji na temat danych radarowych, zobacz Usługi pogodowe w Azure Maps. Obsługuje poziomy powiększenia od 0 do 15. Format: rastrowy (png). |
| microsoft.weather.infrared.main |
Kafelki na podczerwonej pogodzie. Najnowsze obrazy satelitarne podczerwieni pokazują chmury według ich temperatury. Aby uzyskać więcej informacji, zobacz Zasięg usług pogodowych Azure Maps. Aby uzyskać więcej informacji na temat zwróconych danych satelitarnych, zobacz Usługi pogodowe w Azure Maps. Obsługuje poziomy powiększenia od 0 do 15. Format: rastrowy (png). |
| microsoft.traffic.absolute |
bezwzględne kafelki ruchu w wektorze |
| microsoft.traffic.absolute.main |
bezwzględne kafelki ruchu w rasterze w naszym głównym stylu. |
| microsoft.traffic.relative |
kafelki ruchu względnego w wektorze |
| microsoft.traffic.relative.main |
kafelki ruchu względnego w rasterze w naszym głównym stylu. |
| microsoft.traffic.relative.dark |
względne kafelki ruchu w rasterze w naszym ciemnym stylu. |
| microsoft.traffic.delay |
kafelki ruchu w wektorze |
| microsoft.traffic.delay.main |
kafelki ruchu w rasterze w naszym głównym stylu |
| microsoft.traffic.reduced.main |
zmniejszenie liczby kafelków ruchu w rasterze w naszym głównym stylu |
| microsoft.traffic.incident |
kafelki incydentów w wektorze |