Render - Get Map Tile

  • Referensi
Service:
Maps
API Version:
1.0

Berlaku untuk: lihat tingkat harga.

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

Name In Required Type Description
format
 path True

Format respons yang diinginkan. Nilai yang mungkin adalah png & pbf.
api-version
 query True
  • string

Nomor versi API Azure Maps.
layer
 query True

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

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

Ukuran petak peta yang dikembalikan dalam piksel.
view
 query

Parameter Tampilan (juga disebut parameter "wilayah pengguna"), memungkinkan Anda menampilkan peta yang benar untuk negara/wilayah tertentu untuk wilayah yang disengketakan secara geopolitik. Negara yang berbeda memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara 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 dalam Azure Maps harus digunakan sesuai dengan hukum yang berlaku, termasuk yang terkait dengan pemetaan, negara 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

Name Required Type Description
x-ms-client-id
  • string

Menentukan akun mana yang ditujukan untuk penggunaan bersama dengan model keamanan Azure AD. Ini mewakili ID unik untuk akun Azure Maps dan dapat diambil dari API Akun bidang manajemen Azure Maps. Untuk menggunakan keamanan Azure AD di Azure Maps lihat artikel berikut untuk panduan.

Respons

Name Type Description
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

Terjadi kesalahan tak terduga.

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

Keamanan

AADToken

Ini adalah Alur OAuth2 Azure Active Directory. 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 Peta.

Authorization URL khusus untuk instans cloud publik Azure. Sovereign cloud memiliki URL Otorisasi yang unik dan konfigurasi direktori Azure Active. * 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.

  • Saat ini, Azure Active Directory v1.0 atau v2.0 mendukung Kantor, Sekolah, dan Tamu tetapi tidak mendukung akun Pribadi.

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

Scopes

Name Description
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 Azure, PowerShell, CLI, Azure SDK, atau REST API.

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

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan akses server-ke-server Azure Maps REST API tempat kunci ini 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

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

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. Berbagai negara memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara 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 dalam Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara tempat peta, gambar, dan data lain dan konten pihak ketiga yang Anda beri wewenang untuk diakses 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.

Name Type Description
info
  • object

Info tambahan.
type
  • string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Name Type Description
additionalInfo

Info tambahan kesalahan.
code
  • string

Kode kesalahan.
details

Detail kesalahan.
message
  • string

Pesan kesalahan.
target
  • string

Target kesalahan.

ErrorResponse

Respons kesalahan

Name Type Description
error

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. Berbagai negara memiliki tampilan yang berbeda dari wilayah tersebut, dan parameter Tampilan memungkinkan aplikasi Anda untuk mematuhi tampilan yang diperlukan oleh negara 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 dalam Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara tempat peta, gambar, dan data lain dan konten pihak ketiga yang Anda beri wewenang untuk diakses melalui Azure Maps tersedia. Contoh: view=IN.

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

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.

Name Type Description
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.