Render - Get Map Tile

Layanan:

Maps

Versi API:

2024-04-01

Gunakan untuk meminta petak peta dalam format vektor atau raster.

Get Map Tiles API dalam permintaan HTTP GET yang memungkinkan pengguna untuk meminta petak peta dalam format vektor atau raster biasanya diintegrasikan ke dalam kontrol peta atau SDK. Beberapa contoh petak peta yang dapat diminta adalah petak peta jalan Azure Maps, petak peta Radar Cuaca real time, atau petak peta yang dibuat menggunakan Azure Maps Creator. Secara default, Azure Maps menggunakan petak peta vektor untuk kontrol peta webnya (Web SDK) dan Android SDK.

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

Dengan parameter opsional:

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
api-version	query	True	string	Nomor versi API Azure Maps. Versi saat ini adalah 2024-04-01.
tilesetId	query	True	TilesetID	Tileset adalah kumpulan data raster atau vektor yang dipecah menjadi kisi-kisi seragam petak peta persegi pada tingkat zoom preset. Setiap tileset memiliki tilesetId untuk digunakan saat membuat permintaan. TilesetId untuk tileset yang dibuat menggunakan Azure Maps Creator dihasilkan melalui Tileset Create API. Set petak peta siap pakai yang disediakan oleh Azure Maps tercantum di bawah ini. Misalnya, microsoft.base.
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.
timeStamp	query		string date-time	Tanggal dan waktu yang diinginkan dari petak peta yang diminta. Parameter ini harus ditentukan dalam format tanggal-waktu standar (misalnya 2019-11-14T16:03:00-08:00), seperti yang ditentukan oleh ISO 8601. Parameter ini hanya didukung ketika parameter tilesetId diatur ke salah satu nilai di bawah ini. microsoft.weather.infrared.main: Kami menyediakan petak peta hingga 3 jam sebelumnya. Petak peta tersedia dalam interval 10 menit. Kami membulatkan nilai timeStamp ke jangka waktu 10 menit terdekat. microsoft.weather.radar.main: Kami menyediakan petak peta hingga 1,5 jam sebelumnya dan hingga 2 jam di masa mendatang. Petak peta tersedia dalam interval 5 menit. Kami membulatkan nilai timeStamp ke jangka waktu 5 menit terdekat.
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 ID Microsoft Entra. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Respons

Nama	Jenis	Deskripsi
200 OK	object	Petak peta dikembalikan dari panggilan API yang berhasil. Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Header 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 Microsoft Entra OAuth 2.0 . Saat dipasangkan dengan kontrol akses berbasis peran Azure , kontrol akses tersebut dapat digunakan untuk mengontrol akses ke REST API Azure Maps. 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 ke REST API Azure Maps.

Untuk menerapkan skenario, sebaiknya lihat konsep autentikasi. Singkatnya, definisi keamanan ini menyediakan solusi untuk memodelkan 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 ID Microsoft Entra. * Kontrol akses berbasis peran Azure dikonfigurasi dari bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API. * Penggunaan Azure Maps Web SDK memungkinkan penyiapan aplikasi berbasis konfigurasi untuk beberapa kasus penggunaan.

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

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

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

subscription-key

Ini adalah kunci bersama yang disediakan saat membuat sumber daya Azure Maps melalui bidang manajemen Azure melalui portal Microsoft Azure, PowerShell, CLI, Azure SDK, atau REST API.

Dengan kunci ini, aplikasi apa pun berwenang untuk mengakses semua REST API. Dengan kata lain, saat ini dapat diperlakukan sebagai kunci master ke akun tempat kunci tersebut dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server dari REST API Azure Maps tempat kunci ini dapat disimpan dengan aman.

Jenis: apiKey
Dalam: header

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 Microsoft 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 halus ke kedaluwarsa, laju, 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 asal tertentu yang diizinkan di sumber daya akun Peta untuk membatasi penyalahgunaan penyalahgunaan dan memperbarui Token SAS secara teratur.

Jenis: apiKey
Dalam: header

Contoh

Successful Tile Request

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

200

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

"binary image string"

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 diizinkan untuk Anda akses melalui Azure Maps tersedia. Contoh: view=IN. Silakan lihat Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.
MapTileSize	Ukuran petak peta yang dikembalikan dalam piksel.
TilesetID	Tileset adalah kumpulan data raster atau vektor yang dipecah menjadi kisi-kisi seragam petak peta persegi pada tingkat zoom preset. Setiap tileset memiliki tilesetId untuk digunakan saat membuat permintaan. tilesetId untuk tileset yang dibuat menggunakan Azure Maps Creator dihasilkan melalui Tileset Create API. Set petak peta siap pakai yang disediakan oleh Azure Maps tercantum di bawah ini. Misalnya, microsoft.base.

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 diizinkan untuk Anda akses 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)

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.

TilesetID

Tileset adalah kumpulan data raster atau vektor yang dipecah menjadi kisi-kisi seragam petak peta persegi pada tingkat zoom preset. Setiap tileset memiliki tilesetId untuk digunakan saat membuat permintaan. tilesetId untuk tileset yang dibuat menggunakan Azure Maps Creator dihasilkan melalui Tileset Create API. Set petak peta siap pakai yang disediakan oleh Azure Maps tercantum di bawah ini. Misalnya, microsoft.base.

Nama	Jenis	Deskripsi
microsoft.base	string	Peta dasar adalah peta standar yang menampilkan jalan, fitur alami dan buatan bersama dengan label untuk fitur-fitur tersebut dalam petak peta vektor. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: vektor (pbf).
microsoft.base.darkgrey	string	Semua lapisan dengan gaya abu-abu gelap kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.base.hybrid	string	Menampilkan data jalan, batas, dan label dalam petak peta vektor. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: vektor (pbf).
microsoft.base.hybrid.darkgrey	string	Jalan, batas, dan melabeli data dalam gaya abu-abu gelap kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.base.hybrid.road	string	Data jalan, batas, dan label dalam gaya utama kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.base.labels	string	Menampilkan label untuk jalan, fitur alami dan buatan dalam petak peta vektor. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: vektor (pbf).
microsoft.base.labels.darkgrey	string	Beri label data dalam gaya abu-abu gelap kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.base.labels.road	string	Beri label data dalam gaya utama kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.base.road	string	Semua lapisan dengan gaya utama kami. Mendukung tingkat perbesar tampilan 0 hingga 22. Format: raster (png).
microsoft.imagery	string	Kombinasi citra satelit dan udara. Hanya tersedia dalam SKU harga S1. Mendukung tingkat pembesaran tampilan 1 hingga 19. Format: raster (jpeg).
microsoft.terra.main	string	Lapisan bayangan lega dan terra. Mendukung tingkat pembesaran tampilan 0 hingga 6. Format: raster (png).
microsoft.traffic.absolute	string	petak peta lalu lintas absolut di vektor
microsoft.traffic.absolute.main	string	ubin lalu lintas absolut dalam raster dalam gaya utama kami.
microsoft.traffic.delay	string	petak peta lalu lintas di vektor
microsoft.traffic.delay.main	string	petak peta lalu lintas dalam raster dalam gaya utama kami
microsoft.traffic.incident	string	petak peta insiden di vektor
microsoft.traffic.reduced.main	string	mengurangi petak peta lalu lintas dalam raster dalam gaya utama kami
microsoft.traffic.relative	string	petak peta lalu lintas relatif di vektor
microsoft.traffic.relative.dark	string	petak peta lalu lintas relatif dalam raster dalam gaya gelap kita.
microsoft.traffic.relative.main	string	petak peta lalu lintas relatif dalam raster dalam gaya utama kami.
microsoft.weather.infrared.main	string	Petak peta inframerah cuaca. Gambar Satelit Inframerah terbaru menunjukkan awan berdasarkan suhunya. Untuk informasi selengkapnya, lihat Cakupan layanan cuaca Azure Maps. Untuk informasi selengkapnya tentang data satelit yang dikembalikan, lihat Layanan cuaca di Azure Maps. Mendukung tingkat perbesar tampilan 0 hingga 15. Format: raster (png).
microsoft.weather.radar.main	string	Petak radar cuaca. Gambar radar cuaca terbaru termasuk daerah hujan, salju, es dan kondisi campuran. Untuk informasi selengkapnya tentang cakupan layanan Azure Maps Weather, lihat Cakupan layanan cuaca Azure Maps. Untuk informasi selengkapnya tentang data Radar, lihat Layanan cuaca di Azure Maps. Mendukung tingkat perbesar tampilan 0 hingga 15. Format: raster (png).