Udostępnij za pośrednictwem

Render - Get Map Tile

Usługa:
Maps
Wersja interfejsu API:
2024-04-01

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 drogowe Azure Maps oraz kafelki radaru pogodowego w czasie rzeczywistym. Domyślnie Azure Maps Web SDK używa kafelków wektorowych do renderowania kontroli mapy webowej.

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
Z parametrami opcjonalnymi: 
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

Version number of Azure Maps API. aktualna wersja to 2024-04-01.
tilesetId
 query True

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ń. Gotowe do użycia zestawy kafelków dostarczone przez Azure Maps są wymienione poniżej. 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, 2zoom -1].

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, 2zoom -1].

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.
tileSize
 query

MapTileSize

Rozmiar zwróconego 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.podczerwieni.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: Udostępniamy kafelki do 1,5 godziny 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 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 Widok w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym tymi dotyczącymi mapowania, dla kraju/regionu, w którym dostępne są mapy, obrazy, inne dane i treści stron trzecich, do których masz uprawnienia za pośrednictwem 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 bezpieczeństwa Microsoft Entra ID. Ten unikalny identyfikator konta Azure Maps można uzyskać z API Azure Maps Account API na płaszczyźnie zarządzania. Więcej informacji na temat korzystania z Microsoft Entra ID zabezpieczeń w Azure Maps można znaleźć w Manage authentication in 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

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 Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. Każdy użytkownik, grupa lub podmiot usługi może otrzymać dostęp poprzez wbudowaną rolę lub niestandardową rolę składającą się z jednego lub więcej uprawnień do Azure Maps REST API.

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 bezpieczeństwa wymaga użycia nagłówka x-ms-client-id do wskazania, do którego Azure Maps zasobu aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps.

Authorization URL jest specyficzny dla Azure instancji chmury publicznej. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. * Kontrola dostępu oparta na rolach Azure jest konfigurowana z płaszczyzny zarządzania Azure za pośrednictwem Azure portalu, PowerShell, CLI, Azure SDKs lub API REST. * Użycie Azure Maps Web SDK umożliwia konfigurację aplikacji do wielu zastosowań.

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ółdzielony, który jest przydzielany podczas tworzenia zasobu Azure Maps zasob przez płaszczyznę zarządzania Azure za pośrednictwem Azure portalu, PowerShell, CLI, Azure SDKs lub 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 aplikacji udostępnionych publicznie zalecamy korzystanie z dostępu serwer-to-server do API REST Azure Maps, gdzie ten klucz można bezpiecznie przechowywać.

Typ: apiKey
W: header

SAS Token

Jest to token podpisu współdostępu, który jest tworzony na podstawie operacji List SAS na Azure Maps resource przez płaszczyznę zarządzania Azure za pomocą Azure portalu, PowerShell, CLI, Azure SDKs lub REST API.

Dzięki temu tokenowi każda aplikacja jest upoważniona do dostępu za pomocą Azure opartej na rolach kontroli dostępu i precyzyjnej kontroli do daty wygaśnięcia, szybkości i regionu użycia danego tokena. 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ź

Kod stanu:
200 
Content-Type: application/vnd.mapbox-vector-tile
"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 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 Widok w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym tymi dotyczącymi mapowania, dla kraju/regionu, w którym dostępne są mapy, obrazy, inne dane i treści stron trzecich, do których masz uprawnienia za pośrednictwem 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.
MapTileSize

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ń. Gotowe do użycia zestawy kafelków dostarczone przez Azure Maps są wymienione poniżej. Na przykład microsoft.base.

ErrorAdditionalInfo

Objekt

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

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

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

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

LocalizedMapView

Wyliczenie

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 Widok w Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym tymi dotyczącymi mapowania, dla kraju/regionu, w którym dostępne są mapy, obrazy, inne dane i treści stron trzecich, do których masz uprawnienia za pośrednictwem 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

United States of America
YE

Jemen (widok arabski)
Auto

Zwróć dane mapy na podstawie adresu IP żądania.
Unified

Ujednolicony widok (inne)

MapTileSize

Wyliczenie

Rozmiar zwróconego kafelka mapy w pikselach.

Wartość Opis
256

Zwróć kafelek 256 o 256 pikseli.
512

Zwróć kafelek 512 o 512 pikseli.

TilesetID

Wyliczenie

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ń. Gotowe do użycia zestawy kafelków dostarczone przez Azure Maps są wymienione poniżej. 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. Więcej informacji o pokryciu usług pogodowych Azure Maps można znaleźć w Azure Maps coverage weather services. Więcej informacji o danych radarowych można znaleźć w 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. Więcej informacji można znaleźć w Azure Maps coverage weather services. Więcej informacji o danych satelitarnych można znaleźć w 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