Render - Get Map Tile

Service:

Maps

API Version:

1.0

gunakan untuk mendapatkan petak peta dalam format vektor atau raster biasanya untuk diintegrasikan ke dalam kontrol peta atau SDK baru.

Catatan

Azure Maps Penghentian layanan Render v1

Layanan Azure Maps Render v1 sekarang tidak digunakan lagi dan akan dihentikan pada 17/9/26. Untuk menghindari gangguan layanan, semua panggilan ke Render v1 API perlu diperbarui untuk menggunakan Render v2 API dengan 17/9/26.

Mengambil petak peta dalam format vektor atau raster biasanya untuk diintegrasikan ke dalam kontrol peta atau SDK baru. Secara default, Azure menggunakan petak peta vektor untuk kontrol peta webnya (lihat Tingkat Pembesaran Tampilan dan Kisi Petak Peta)

Catatan: Petak peta Cuaca hanya tersedia melalui Get Map Tile V2 API. Sebaiknya mulai gunakan Get Map Tile V2 API baru.

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

With optional parameters:

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
format	path	True	TileFormat	Format respons yang diinginkan. Nilai yang mungkin adalah png & pbf.
api-version	query	True	string	Nomor versi API Azure Maps.
layer	query	True	MapTileLayer	Lapisan peta diminta. Nilai yang mungkin adalah dasar, hibrid, label, dan terra.
style	query	True	MapTileStyle	Gaya peta yang akan dikembalikan. Nilai yang mungkin adalah utama, gelap, dan shaded_relief.
x	query	True	integer int32	Koordinat X petak peta pada kisi zoom. Nilai harus dalam rentang [0, 2zoom -1]. Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak untuk detailnya.
y	query	True	integer int32	Koordinat petak peta Y pada kisi zoom. Nilai harus dalam rentang [0, 2zoom -1]. Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak untuk detailnya.
zoom	query	True	integer int32	Tingkat perbesar tampilan untuk petak peta yang diinginkan. Silakan lihat Tingkat Pembesaran Tampilan dan Kisi Petak untuk detailnya.
language	query		string	Bahasa tempat hasil pencarian harus dikembalikan. Harus menjadi salah satu tag bahasa IETF yang didukung, tidak peka huruf besar/kecil. Saat data dalam bahasa tertentu tidak tersedia untuk bidang tertentu, bahasa default digunakan. Silakan merujuk ke Bahasa yang Didukung untuk detailnya.
tileSize	query		MapTileSize	Ukuran petak peta yang dikembalikan dalam piksel.
view	query		LocalizedMapView	Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan hukum yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang berwenang untuk Anda akses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-id		string	Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Microsoft Entra ID. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Microsoft Entra ID di Azure Maps lihat artikel berikut untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	object	Gambar ini dikembalikan dari panggilan Petak Peta Get yang berhasil Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	Terjadi kesalahan tak terduga. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Keamanan

AADToken

Ini adalah alur OAuth 2.0 Microsoft Entra. Saat dipasangkan dengan kontrol akses berbasis peran Azure, kontrol akses tersebut dapat digunakan untuk mengontrol akses ke Azure Maps REST API. Kontrol akses berbasis peran Azure digunakan untuk menunjuk akses ke satu atau beberapa akun sumber daya atau sub-sumber daya Azure Maps. Setiap pengguna, grup, atau perwakilan layanan dapat diberikan akses melalui peran bawaan atau peran kustom yang terdiri dari satu atau beberapa izin untuk Azure Maps REST API.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk pemodelan aplikasi melalui objek yang mampu mengontrol akses pada API dan cakupan tertentu.

Catatan

• Definisi keamanan ini memerlukan penggunaan x-ms-client-id header untuk menunjukkan sumber daya Azure Maps mana yang meminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi Microsoft Entra ID. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan berbasis konfigurasi aplikasi untuk beberapa kasus penggunaan.

• Untuk informasi selengkapnya tentang platform identitas Microsoft, lihat gambaran umum platform identitas Microsoft.

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

Scopes

Nama	Deskripsi
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Ini adalah kunci bersama yang disediakan saat Anda Membuat akun Azure Maps di portal Azure atau menggunakan PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun dapat mengakses semua REST API. Dengan kata lain, kunci ini dapat digunakan sebagai kunci master di akun tempat kunci tersebut diterbitkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses Azure Maps REST API sehingga kunci Anda dapat disimpan dengan aman.

Type: apiKey
In: query

SAS Token

Ini adalah token tanda tangan akses bersama dibuat dari operasi Daftar SAS pada sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan token ini, aplikasi apa pun berwenang untuk mengakses dengan kontrol akses berbasis peran Azure dan kontrol fine-grain ke kedaluwarsa, tarif, dan wilayah penggunaan untuk token tertentu. Dengan kata lain, Token SAS dapat digunakan untuk memungkinkan aplikasi mengontrol akses dengan cara yang lebih aman daripada kunci bersama.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah mengonfigurasi daftar spesifik asal yang diizinkan pada sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Type: apiKey
In: header

Contoh

Successful Tile Request

Sample Request

HTTP

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

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{file}"

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
LocalizedMapView	Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang anda berwenang untuk mengakses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.
MapTileLayer	Lapisan peta diminta. Nilai yang mungkin adalah dasar, hibrid, label, dan terra.
MapTileSize	Ukuran petak peta yang dikembalikan dalam piksel.
MapTileStyle	Gaya peta yang akan dikembalikan. Nilai yang mungkin adalah utama, gelap, dan shaded_relief.
TileFormat	Format respons yang diinginkan. Nilai yang mungkin adalah png & pbf.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

LocalizedMapView

Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara/wilayah yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara/wilayah yang akan dilayani aplikasi Anda. Secara default, parameter Tampilan diatur ke "Terpadu" meskipun Anda belum menentukannya dalam permintaan. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Atau, Anda memiliki opsi untuk mengatur 'View=Auto', yang akan mengembalikan data peta berdasarkan alamat IP permintaan. Parameter Tampilan di Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang anda berwenang untuk mengakses melalui Azure Maps tersedia. Contoh: view=IN.

Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Nama	Jenis	Deskripsi
AE	string	Uni Emirat Arab (Tampilan Arab)
AR	string	Argentina (Tampilan Argentina)
Auto	string	Kembalikan data peta berdasarkan alamat IP permintaan.
BH	string	Bahrain (Tampilan Arab)
IN	string	India (Tampilan India)
IQ	string	Irak (Tampilan Arab)
JO	string	Yordania (Tampilan Arab)
KW	string	Kuwait (Tampilan Arab)
LB	string	Lebanon (Tampilan Arab)
MA	string	Maroko (Tampilan Maroko)
OM	string	Oman (Tampilan Arab)
PK	string	Pakistan (Tampilan Pakistan)
PS	string	Otoritas Palestina (Tampilan Arab)
QA	string	Qatar (Tampilan Arab)
SA	string	Arab Saudi (Tampilan Arab)
SY	string	Suriah (Tampilan Arab)
Unified	string	Tampilan Terpadu (Lainnya)
YE	string	Yaman (Tampilan Arab)

MapTileLayer

Lapisan peta diminta. Nilai yang mungkin adalah dasar, hibrid, label, dan terra.

Nama	Jenis	Deskripsi
basic	string	Mengembalikan petak yang berisi semua fitur peta termasuk poligon, batas, jalan, dan label.
hybrid	string	Mengembalikan ubin yang berisi batas, jalan, dan label, dan dapat dilapisi pada petak peta lain (seperti citra satelit) untuk menghasilkan petak peta hibrid.
labels	string	Mengembalikan petak peta hanya dari informasi label peta.
terra	string	Kanvas peta lengkap dengan petak peta relief bertaung. Tingkat pembesaran tampilan 0-6 (inklusif) didukung. Png adalah satu-satunya TileFormat yang didukung dan hanya MapTileSize yang tersedia adalah 512.

MapTileSize

Ukuran petak peta yang dikembalikan dalam piksel.

Nama	Jenis	Deskripsi
256	string	Mengembalikan petak peta 256 x 256 piksel.
512	string	Mengembalikan petak peta 512 x 512 piksel.

MapTileStyle

Gaya peta yang akan dikembalikan. Nilai yang mungkin adalah utama, gelap, dan shaded_relief.

Nama	Jenis	Deskripsi
dark	string	Versi abu-abu tua dari gaya utama Azure Maps. PNG adalah satu-satunya TileFormat yang didukung.
main	string	Azure Maps gaya utama
shaded_relief	string	Azure Maps gaya utama dilengkapi dengan relief bertaung. Didukung oleh Layer terra.

TileFormat

Format respons yang diinginkan. Nilai yang mungkin adalah png & pbf.

Nama	Jenis	Deskripsi
pbf	string	Grafik vektor dalam format pbf. Mendukung tingkat perbesar tampilan 0 hingga 22.
png	string	Gambar dalam format png. Mendukung tingkat perbesar tampilan 0 hingga 18.