Render - Get Map Tile

Usługa:

Maps

Wersja interfejsu API:

1.0

służy do pobierania kafelków mapy w formacie wektorowym lub rasterowym zwykle do zintegrowania z nową kontrolką mapy lub zestawem SDK.

Uwaga

wycofanie usługi renderowania w wersji 1 Azure Maps

Usługa renderowania w wersji 1 Azure Maps jest teraz przestarzała i zostanie wycofana w dniu 26.09.17. Aby uniknąć przerw w działaniu usługi, wszystkie wywołania interfejsu API renderowania w wersji 1 muszą zostać zaktualizowane w celu korzystania z interfejsu API renderowania w wersji 2 przez 17.09.26.

Pobiera kafelki mapy w formacie wektorowym lub rasterowym zwykle do zintegrowania z nową kontrolką mapy lub zestawem SDK. Domyślnie platforma Azure używa kafelków mapy wektorowej dla kontrolki mapy internetowej (zobacz Poziomy powiększenia i Siatka kafelków)

Uwaga: kafelki pogody są dostępne tylko za pośrednictwem interfejsu API Pobierz kafelek mapy w wersji 2. Zalecamy rozpoczęcie korzystania z nowego interfejsu API Pobierz kafelek mapy w wersji 2.

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}

Z parametrami opcjonalnymi:

GET https://atlas.microsoft.com/map/tile/{format}?api-version=1.0&layer={layer}&style={style}&zoom={zoom}&x={x}&y={y}&tileSize={tileSize}&language={language}&view={view}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
format	path	True	TileFormat	Żądany format odpowiedzi. Możliwe wartości to png & pbf.
api-version	query	True	string	Numer wersji interfejsu API Azure Maps.
layer	query	True	MapTileLayer	Zażądano warstwy mapy. Możliwe wartości to podstawowe, hybrydowe, etykiety i terra.
style	query	True	MapTileStyle	Styl mapy, który ma zostać zwrócony. Możliwe wartości to główne, ciemne i shaded_relief.
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. 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, zapoznaj się z tematem Obsługiwane języki .
tileSize	query		MapTileSize	Rozmiar zwracanego kafelka mapy w pikselach.
view	query		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 .

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	Ten obraz jest zwracany z pomyślnego wywołania kafelka Pobierz mapę 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. Po 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 Azure Maps konta zasobu 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ęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi 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łówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

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 poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

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

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ółużytkowany podczas tworzenia konta Azure Maps w Azure Portal lub przy użyciu programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsu API REST.

Za pomocą tego klucza każda aplikacja może uzyskiwać dostęp do wszystkich interfejsów API REST. Innymi słowy, ten klucz może służyć jako klucz główny na koncie, w którym są wystawiane.

W przypadku publicznie uwidocznionych aplikacji zalecamy użycie podejścia do poufnych aplikacji klienckich w celu uzyskania dostępu Azure Maps interfejsów API REST, aby klucz mógł być bezpiecznie przechowywany.

Typ: apiKey
W: query

SAS Token

Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji list sygnatur dostępu współdzielonego na zasobie Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem 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 oraz 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 bezpieczny 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 SAS.

Typ: apiKey
W: header

Przykłady

Successful Tile Request

Przykładowe żądanie

HTTP

GET https://atlas.microsoft.com/map/tile/png?api-version=1.0&layer=basic&style=main&zoom=6&x=10&y=22

Przykładowa odpowiedź

Kod stanu:

200

Content-Type: image/png

"{file}"

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 .
MapTileLayer	Zażądano warstwy mapy. Możliwe wartości to podstawowe, hybrydowe, etykiety i terra.
MapTileSize	Rozmiar zwracanego kafelka mapy w pikselach.
MapTileStyle	Styl mapy, który ma zostać zwrócony. Możliwe wartości to główne, ciemne i shaded_relief.
TileFormat	Żądany format odpowiedzi. Możliwe wartości to png & pbf.

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)

MapTileLayer

Zażądano warstwy mapy. Możliwe wartości to podstawowe, hybrydowe, etykiety i terra.

Nazwa	Typ	Opis
basic	string	Zwraca kafelek zawierający wszystkie funkcje mapy, w tym wielokąty, obramowania, drogi i etykiety.
hybrid	string	Zwraca kafelek zawierający obramowania, drogi i etykiety i może być nakładany na inne kafelki (takie jak obrazy satelitarne) w celu utworzenia kafelków hybrydowych.
labels	string	Zwraca kafelek tylko informacji o etykiecie mapy.
terra	string	Kanwa mapy wraz z zacienionymi kafelkami ulgi. Obsługiwane są poziomy powiększenia 0–6 (włącznie). Png jest jedynym obsługiwanym formatem TileFormat, a dostępny tylko rozmiar MapTileSize to 512.

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.

MapTileStyle

Styl mapy, który ma zostać zwrócony. Możliwe wartości to główne, ciemne i shaded_relief.

Nazwa	Typ	Opis
dark	string	Ciemnoszary wersja głównego stylu Azure Maps. Format PNG jest jedynym obsługiwanym formatem TileFormat.
main	string	Azure Maps stylu głównym
shaded_relief	string	Azure Maps głównym stylem zakończonym cieniowanym ukośną ulgą. Obsługiwane przez narzędzie Terra warstwy.

TileFormat

Żądany format odpowiedzi. Możliwe wartości to png & pbf.

Nazwa	Typ	Opis
pbf	string	Grafika wektorowa w formacie pbf. Obsługuje poziomy powiększenia od 0 do 22.
png	string	Obraz w formacie png. Obsługuje poziomy powiększenia od 0 do 18.