Search - Get Search Address Reverse
Gunakan untuk mendapatkan alamat jalan dan info lokasi dari koordinat lintang dan bujur.
Get Search Address Reverse
API adalah permintaan HTTP GET
yang mengembalikan alamat atau lokasi jalan ketika diberikan koordinat lintang dan bujur.
Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: 37.786505, -122.3862) ke alamat jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin tahu alamat apa di mana koordinat berada. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu.
GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
format
|
path | True |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
|
api-version
|
query | True |
string |
Nomor versi API Azure Maps. |
query
|
query | True |
number[] |
Kueri yang berlaku ditentukan sebagai string yang dipisahkan koma yang terdiri dari garis lintang diikuti dengan bujur misalnya " 47.641268,-122.125679". |
allow
|
query |
boolean |
Format baris baru dalam alamat yang diformat. Jika true, alamat akan berisi baris baru. Jika false, baris baru akan dikonversi ke koma. |
|
entity
|
query |
Menentukan tingkat pemfilteran yang dilakukan pada geografi. Mempersempit pencarian untuk jenis entitas geografi tertentu, misalnya hanya mengembalikan kotamadya. Respons yang dihasilkan akan berisi ID geografi serta jenis entitas yang cocok. Jika Anda menyediakan lebih dari satu entitas sebagai daftar yang dipisahkan koma, titik akhir akan mengembalikan 'entitas terkecil yang tersedia'. ID Geometri yang dikembalikan dapat digunakan untuk mendapatkan geometri geografi tersebut melalui Get Search Polygon API. Parameter berikut diabaikan saat entityType diatur:
|
||
heading
|
query |
integer |
Arah menuju kendaraan dalam derajat, untuk perjalanan sepanjang segmen jalan raya. 0 adalah Utara, 90 adalah Timur dan sebagainya, nilai berkisar dari -360 hingga 360. Presisi dapat mencakup hingga satu tempat desimal |
|
language
|
query |
string |
Bahasa di mana 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. |
|
number
|
query |
string |
Nomor jalan sebagai string. Jika angka dikirim bersama dengan permintaan, respons dapat mencakup sisi jalan (Kiri/Kanan) dan juga posisi offset untuk angka tersebut |
|
radius
|
query |
integer |
Radius dalam meter ke agar hasil dibatasi ke area yang ditentukan |
|
return
|
query |
boolean |
Sertakan informasi tentang jenis kecocokan yang dicapai geocoder dalam respons. |
|
return
|
query |
boolean |
Boolean. Untuk mengaktifkan pengembalian array penggunaan jalan untuk geocode terbalik di tingkat jalan |
|
return
|
query |
boolean |
Boolean. Untuk mengaktifkan pengembalian batas kecepatan yang diposting |
|
road
|
query |
Untuk membatasi geocode terbalik ke jenis penggunaan jalan tertentu. Array penggunaan jalan untuk geocode terbalik dapat berupa satu atau beberapa LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet |
||
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/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. |
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 |
OK |
|
Other Status Codes |
Terjadi kesalahan tak terduga. |
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.
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 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.
Jenis:
apiKey
Dalam:
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.
Jenis:
apiKey
Dalam:
header
Contoh
Searches addresses for coordinates 37.337,-121.89
Permintaan sampel
GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89
Respon sampel
{
"summary": {
"queryTime": 5,
"numResults": 1
},
"addresses": [
{
"address": {
"streetNumber": "31",
"routeNumbers": [],
"streetName": "N 2nd St",
"streetNameAndNumber": "31 N 2nd St",
"countryCode": "US",
"countrySubdivisionCode": "CA",
"countrySubdivisionName": "California",
"municipality": "San Jose",
"postalCode": "95113",
"country": "United States of America",
"countryCodeISO3": "USA",
"freeformAddress": "31 N 2nd St, San Jose CA 95113",
"extendedPostalCode": "951131217"
},
"position": "37.337090,-121.889820"
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Address |
Alamat hasil |
Bounding |
Kotak pembatas lokasi. |
Entity |
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi. |
Error |
Info tambahan kesalahan manajemen sumber daya. |
Error |
Detail kesalahan. |
Error |
Respons kesalahan |
Geographic |
Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia. |
Lat |
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'. |
Localized |
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. |
Match |
Jenis kecocokan untuk operasi pencarian alamat terbalik. |
Query |
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. |
Response |
Format respons yang diinginkan. Nilai dapat berupa json atau xml. |
Reverse |
Objek ini dikembalikan dari panggilan terbalik Alamat Search berhasil |
Reverse |
Objek hasil untuk respons Balik Alamat Search |
Road |
Menjelaskan kemungkinan penggunaan jalan. |
Search |
Objek ringkasan untuk respons API Search. |
Address
Alamat hasil
Nama | Jenis | Deskripsi |
---|---|---|
boundingBox |
Kotak pembatas lokasi. |
|
buildingNumber |
string |
Nomor bangunan di jalan. Tidak digunakan lagi, gunakan streetNumber sebagai gantinya. |
country |
string |
nama negara/wilayah |
countryCode |
string |
Negara (Catatan: Ini adalah kode dua huruf, bukan nama negara/wilayah.) |
countryCodeISO3 |
string |
Kode negara ISO alpha-3 |
countrySecondarySubdivision |
string |
County |
countrySubdivision |
string |
Negara Bagian atau Provinsi |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Nama lengkap hierarki administratif negara/wilayah tingkat pertama. Bidang ini hanya muncul jika countrySubdivision disajikan dalam bentuk singkatan. Hanya didukung untuk Amerika Serikat, Kanada, dan Inggris Raya. |
countryTertiarySubdivision |
string |
Area Bernama |
crossStreet |
string |
Nama jalan yang disilangkan. |
extendedPostalCode |
string |
Kode pos yang diperluas (ketersediaan tergantung pada wilayah). |
freeformAddress |
string |
Baris alamat yang diformat sesuai dengan aturan pemformatan negara/wilayah asal Hasil, atau dalam kasus negara/wilayah, nama negara/wilayah lengkapnya. |
localName |
string |
Komponen alamat yang mewakili nama area geografis atau lokalitas yang mengelompokkan beberapa objek yang dapat diatasi untuk tujuan alamat, tanpa menjadi unit administratif. Bidang ini digunakan untuk membangun |
municipality |
string |
Kota/Kota |
municipalitySubdivision |
string |
Sub / Kota Super |
neighbourhood |
string |
Lingkungan adalah area yang dilokalkan secara geografis di dalam kota atau kota dengan karakteristik khas dan interaksi sosial antara penduduk. |
postalCode |
string |
Kode Pos / Kode Pos |
routeNumbers |
string[] |
Kode yang digunakan untuk secara tidak ambigu mengidentifikasi jalan |
street |
string |
Nama jalan. TIDAK DIGUNAKAN LAGI, gunakan streetName sebagai gantinya. |
streetName |
string |
Nama jalan. |
streetNameAndNumber |
string |
Nama dan nomor jalan. |
streetNumber |
string |
Nomor bangunan di jalan. |
BoundingBoxCompassNotation
Kotak pembatas lokasi.
Nama | Jenis | Deskripsi |
---|---|---|
entity |
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi. |
|
northEast |
string |
Garis lintang utara-timur, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma |
southWest |
string |
Garis lintang barat daya, koordinat bujur kotak pembatas sebagai float yang dipisahkan koma |
Entity
Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.
Nama | Jenis | Deskripsi |
---|---|---|
position |
string |
Entitas posisi |
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 |
Info tambahan kesalahan. |
|
code |
string |
Kode kesalahan. |
details |
Detail kesalahan. |
|
message |
string |
Pesan kesalahan. |
target |
string |
Target kesalahan. |
ErrorResponse
Respons kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek kesalahan. |
GeographicEntityType
Jenis entitas geografi. Hanya ada ketika entityType diminta dan tersedia.
Nama | Jenis | Deskripsi |
---|---|---|
Country |
string |
nama negara/wilayah |
CountrySecondarySubdivision |
string |
County |
CountrySubdivision |
string |
Negara Bagian atau Provinsi |
CountryTertiarySubdivision |
string |
Area Bernama |
Municipality |
string |
Kota/Kota |
MunicipalitySubdivision |
string |
Sub / Kota Super |
Neighbourhood |
string |
Lingkungan |
PostalCodeArea |
string |
Kode Pos / Kode Pos |
LatLongPairAbbreviated
Lokasi yang direpresentasikan sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.
Nama | Jenis | Deskripsi |
---|---|---|
lat |
number |
Properti garis lintang |
lon |
number |
Properti garis bujur |
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) |
MatchType
Jenis kecocokan untuk operasi pencarian alamat terbalik.
Nama | Jenis | Deskripsi |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
QueryType
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.
Nama | Jenis | Deskripsi |
---|---|---|
NEARBY |
string |
Search dilakukan di sekitar garis lintang dan bujur tertentu dengan radius yang ditentukan |
NON_NEAR |
string |
Search dilakukan secara global, tanpa bias pada lintang dan bujur tertentu, dan tidak ada radius yang ditentukan |
ResponseFormat
Format respons yang diinginkan. Nilai dapat berupa json atau xml.
Nama | Jenis | Deskripsi |
---|---|---|
json |
string |
|
xml |
string |
ReverseSearchAddressResult
Objek ini dikembalikan dari panggilan terbalik Alamat Search berhasil
Nama | Jenis | Deskripsi |
---|---|---|
addresses |
Array alamat |
|
summary |
Objek ringkasan untuk respons Balik Alamat Search |
ReverseSearchAddressResultItem
Objek hasil untuk respons Balik Alamat Search
Nama | Jenis | Deskripsi |
---|---|---|
address |
Alamat hasil |
|
matchType |
Informasi tentang jenis kecocokan. Salah satu:
|
|
position |
string |
Properti posisi dalam bentuk "{latitude},{longitude}" |
roadUse |
Menjelaskan kemungkinan penggunaan jalan. |
RoadUseType
Menjelaskan kemungkinan penggunaan jalan.
Nama | Jenis | Deskripsi |
---|---|---|
Arterial |
string |
|
LimitedAccess |
string |
|
LocalStreet |
string |
|
Ramp |
string |
|
Rotary |
string |
|
Terminal |
string |
SearchSummary
Objek ringkasan untuk respons API Search.
Nama | Jenis | Deskripsi |
---|---|---|
fuzzyLevel |
integer |
Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil. |
geoBias |
Indikasi ketika mesin pencari internal telah menerapkan bias geospasial untuk meningkatkan peringkat hasil. Dalam beberapa metode, ini dapat dipengaruhi dengan mengatur parameter lat dan lon jika tersedia. Dalam kasus lain itu murni internal. |
|
limit |
integer |
Jumlah maksimum respons yang akan dikembalikan |
numResults |
integer |
Jumlah hasil dalam respons. |
offset |
integer |
Offset awal dari Hasil yang dikembalikan dalam tataan Hasil lengkap. |
query |
string |
Parameter kueri yang digunakan untuk menghasilkan hasil pencarian ini. |
queryTime |
integer |
Waktu yang dihabiskan untuk menyelesaikan kueri, dalam milidetik. |
queryType |
Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR. |
|
totalResults |
integer |
Jumlah total Hasil yang ditemukan. |