Search - Get Reverse Geocoding
Gunakan untuk mendapatkan alamat jalan dan info lokasi dari koordinat bujur dan lintang.
API Get Reverse Geocoding adalah permintaan http GET yang digunakan untuk menerjemahkan koordinat (misalnya: 37.786505, -122.3862) ke alamat jalan yang dapat dimengerti manusia. Berguna dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat yang terkait dengan koordinat. Titik akhir ini akan mengembalikan informasi alamat untuk koordinat tertentu.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Parameter URI
| Nama | Dalam | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Nomor versi Azure Maps API. |
|
coordinates
|
query | True |
number[] |
Koordinat lokasi yang ingin Anda balikkan geocodenya. Contoh: &coordinates=lon,lat |
|
result
|
query |
Tentukan jenis entitas yang Anda inginkan dalam respons. Hanya jenis yang Anda tentukan yang akan dikembalikan. Jika titik tidak dapat dipetakan ke jenis entitas yang Anda tentukan, tidak ada informasi lokasi yang dikembalikan dalam respons. Nilai default adalah semua entitas yang mungkin. Daftar jenis entitas yang dipisahkan koma yang dipilih dari opsi berikut.
Jenis entitas ini diurutkan dari entitas yang paling spesifik ke entitas yang paling tidak spesifik. Ketika entitas lebih dari satu jenis entitas ditemukan, hanya entitas yang paling spesifik yang dikembalikan. Misalnya, jika Anda menentukan Alamat dan AdminDistrict1 sebagai jenis entitas dan entitas yang ditemukan untuk kedua jenis, hanya informasi entitas Alamat yang dikembalikan dalam respons. |
||
|
view
|
query |
string |
String yang mewakili kode wilayah/negara ISO 3166-1 Alpha-2. Ini akan mengubah batas dan label geopolitik yang disengketakan agar selaras dengan wilayah pengguna yang ditentukan. Secara default, parameter Tampilan diatur ke "Otomatis" meskipun Anda belum menentukannya dalam permintaan. Silakan merujuk ke Tampilan yang Didukung |
Header Permintaan
| Nama | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| 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 sarana manajemen Azure Maps. Untuk informasi selengkapnya tentang menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat Mengelola autentikasi di Azure Maps. |
|
| Accept-Language |
string |
Bahasa tempat hasil pencarian harus dikembalikan. Silakan merujuk ke Bahasa yang Didukung |
Respons
| Nama | Jenis | Deskripsi |
|---|---|---|
| 200 OK |
OK Media Types: "application/geo+json" |
|
| Other Status Codes |
Terjadi kesalahan tak terduga. Media Types: "application/geo+json" |
Keamanan
AADToken
Ini adalah Microsoft Entra OAuth 2.0 Flows. Saat dipasangkan dengan akses berbasis peran Azure kontrol 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.
Nota
- Definisi keamanan ini mengharuskan penggunaan header
x-ms-client-iduntuk menunjukkan sumber daya Azure Maps mana yang diminta akses aplikasi. Ini dapat diperoleh dari API manajemen Maps. -
Authorization URLkhusus 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 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 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, 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 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 butir 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 spesifik asal yang diizinkan pada sumber daya akun peta untuk membatasi penyalahgunaan penyajian dan memperbarui Token SAS secara teratur.
Jenis:
apiKey
Dalam:
header
Contoh
Search point -122.138681, 47.630358
Permintaan sampel
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
Respon sampel
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"formattedAddress": "15127 NE 24th St, Redmond, Washington 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Definisi
| Nama | Deskripsi |
|---|---|
| Address |
Alamat hasil |
|
Admin |
Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah. |
|
Calculation |
Metode yang digunakan untuk menghitung titik geocode. |
|
Confidence |
Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan. Keyakinan lokasi yang dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis dan lokasi pengguna, jika ditentukan. |
|
Country |
|
|
Error |
Info tambahan kesalahan manajemen sumber daya. |
|
Error |
Detail kesalahan. |
|
Error |
Tanggapan kesalahan |
|
Feature |
Jenis objek FeatureCollection harus FeatureCollection. |
|
Features |
|
|
Feature |
Jenis fitur harus Berupa Fitur. |
|
Geocode |
Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan. |
|
Geocoding |
Objek ini dikembalikan dari panggilan Geocoding yang berhasil |
|
Geo |
Jenis geometri |
| Intersection |
Alamat hasilnya. |
|
Match |
Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons. Misalnya, lokasi yang dikodekan secara geografis dengan kode kecocokan Demikian pula, lokasi yang dikodekan secara geografis dengan kode kecocokan Nilai yang mungkin adalah:
|
| Properties | |
|
Reverse |
Tentukan jenis entitas yang Anda inginkan dalam respons. Hanya jenis yang Anda tentukan yang akan dikembalikan. Jika titik tidak dapat dipetakan ke jenis entitas yang Anda tentukan, tidak ada informasi lokasi yang dikembalikan dalam respons. Nilai default adalah semua entitas yang mungkin. Daftar jenis entitas yang dipisahkan koma yang dipilih dari opsi berikut.
Jenis entitas ini diurutkan dari entitas yang paling spesifik ke entitas yang paling tidak spesifik. Ketika entitas lebih dari satu jenis entitas ditemukan, hanya entitas yang paling spesifik yang dikembalikan. Misalnya, jika Anda menentukan Alamat dan AdminDistrict1 sebagai jenis entitas dan entitas yang ditemukan untuk kedua jenis, hanya informasi entitas Alamat yang dikembalikan dalam respons. |
|
Usage |
Penggunaan terbaik untuk titik geocode.
Setiap titik geocode didefinisikan sebagai titik |
Address
Alamat hasil
| Nama | Jenis | Deskripsi |
|---|---|---|
| addressLine |
string |
AddressLine yang menyertakan Nama Dan Nomor Jalan |
| adminDistricts |
Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah. |
|
| countryRegion | ||
| formattedAddress |
string |
Properti Alamat Terformat |
| intersection |
Alamat hasilnya. |
|
| locality |
string |
properti lokalitas |
| neighborhood |
string |
properti lingkungan |
| postalCode |
string |
Properti Kode Pos |
| streetName |
string |
Nama jalan dari formattedAddress |
| streetNumber |
string |
Nomor di jalan, jika tersedia, dari formattedAddress |
AdminDistricts
Nama subdivisi di negara atau wilayah untuk alamat. Elemen ini biasanya diperlakukan sebagai subdivisi administratif urutan pertama, tetapi dalam beberapa kasus juga berisi subdivisi urutan kedua, ketiga, atau keempat di negara, dependensi, atau wilayah.
| Nama | Jenis | Deskripsi |
|---|---|---|
| name |
string |
Nama untuk bidang adminDistrict yang sesuai, Untuk adminDistrict[0], ini bisa menjadi nama lengkap negara bagian seperti Washington, Untuk adminDistrict[1], ini bisa menjadi nama lengkap kabupaten |
| shortName |
string |
Nama pendek untuk bidang adminDistrict yang sesuai, Untuk adminDistrict[0], ini bisa berupa nama pendek status seperti WA, Untuk adminDistrict[1], ini bisa menjadi nama pendek kabupaten |
CalculationMethodEnum
Metode yang digunakan untuk menghitung titik geocode.
| Nilai | Deskripsi |
|---|---|
| Interpolation |
Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi. |
| InterpolationOffset |
Titik geocode dicocokkan dengan titik di jalan menggunakan interpolasi dengan offset tambahan untuk menggeser titik ke sisi jalan. |
| Parcel |
Titik geocode dicocokkan dengan bagian tengah parsel. |
| Rooftop |
Titik geocode dicocokkan dengan atap bangunan. |
ConfidenceEnum
Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan.
Keyakinan lokasi yang dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis dan lokasi pengguna, jika ditentukan.
| Nilai | Deskripsi |
|---|---|
| High |
Jika kepercayaan diatur ke Jika permintaan menyertakan lokasi atau tampilan, peringkat dapat berubah dengan tepat. Misalnya, kueri lokasi untuk "Paris" menampilkan "Paris, Prancis" dan "Paris, TX" dengan |
| Medium |
Dalam beberapa situasi, kecocokan yang ditampilkan mungkin tidak pada level yang sama dengan informasi yang diberikan dalam permintaan. Misalnya, permintaan dapat menentukan informasi alamat dan layanan geocode mungkin hanya dapat mencocokkan kode pos. Dalam hal ini, jika layanan geocode memiliki keyakinan bahwa kode pos cocok dengan data, keyakinan diatur ke Jika informasi lokasi dalam kueri ambigu, dan tidak ada informasi tambahan untuk memberi peringkat lokasi (seperti lokasi pengguna atau kepentingan relatif lokasi), keyakinan diatur ke Jika informasi lokasi dalam kueri tidak memberikan informasi yang cukup untuk melakukan geokode lokasi tertentu, nilai lokasi yang kurang tepat dapat dikembalikan dan keyakinan diatur ke |
| Low |
CountryRegion
| Nama | Jenis | Deskripsi |
|---|---|---|
| ISO |
string |
ISO negara/wilayah |
| name |
string |
nama negara/wilayah |
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
Tanggapan kesalahan
| Nama | Jenis | Deskripsi |
|---|---|---|
| error |
Objek kesalahan. |
FeatureCollectionEnum
Jenis objek FeatureCollection harus FeatureCollection.
| Nilai | Deskripsi |
|---|---|
| FeatureCollection |
FeaturesItem
| Nama | Jenis | Deskripsi |
|---|---|---|
| bbox |
number[] (double) |
Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan lihat RFC 7946 untuk detailnya. |
| geometry |
Jenis geometri |
|
| id |
string |
ID untuk fitur yang dikembalikan |
| properties | ||
| type |
Jenis fitur harus Berupa Fitur. |
FeatureTypeEnum
Jenis fitur harus Berupa Fitur.
| Nilai | Deskripsi |
|---|---|
| Feature |
GeocodePoints
Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan.
| Nama | Jenis | Deskripsi |
|---|---|---|
| calculationMethod |
Metode yang digunakan untuk menghitung titik geocode. |
|
| geometry |
Jenis geometri |
|
| usageTypes |
Penggunaan terbaik untuk titik geocode.
Setiap titik geocode didefinisikan sebagai titik |
GeocodingResponse
Objek ini dikembalikan dari panggilan Geocoding yang berhasil
| Nama | Jenis | Deskripsi |
|---|---|---|
| features | ||
| nextLink |
string |
adalah tautan ke halaman berikutnya dari fitur yang dikembalikan. Jika ini adalah halaman terakhir, tidak ada bidang ini. |
| type |
Jenis objek FeatureCollection harus FeatureCollection. |
GeoJsonPoint
Jenis geometri GeoJSON Point yang valid. Silakan lihat RFC 7946 untuk detailnya.
| Nama | Jenis | Deskripsi |
|---|---|---|
| bbox |
number[] (double) |
Kotak pembatas. Proyeksi yang digunakan - EPSG:3857. Silakan lihat RFC 7946 untuk detailnya. |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Menentukan jenis |
Intersection
Alamat hasilnya.
| Nama | Jenis | Deskripsi |
|---|---|---|
| baseStreet |
string |
Jalan utama untuk lokasi. |
| displayName |
string |
Nama lengkap persimpangan. |
| intersectionType |
string |
Jenis persimpangan. |
| secondaryStreet1 |
string |
Jalan persimpangan pertama. |
| secondaryStreet2 |
string |
Jika ada, jalan persimpangan kedua. |
MatchCodesEnum
Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons.
Misalnya, lokasi yang dikodekan secara geografis dengan kode kecocokan Good dan Ambiguous berarti bahwa lebih dari satu lokasi geocode ditemukan untuk informasi lokasi dan bahwa layanan geocode tidak memiliki hierarki pencarian untuk menemukan kecocokan.
Demikian pula, lokasi yang dikodekan secara geografis dengan kode kecocokan Ambiguous dan UpHierarchy menyiratkan bahwa lokasi geocode tidak dapat ditemukan yang cocok dengan semua informasi lokasi yang disediakan, sehingga layanan geocode harus mencari hierarki atas dan menemukan beberapa kecocokan pada tingkat tersebut. Contoh hasil Ambiguous dan UpHierarchy adalah ketika Anda memberikan informasi alamat lengkap, tetapi layanan geocode tidak dapat menemukan kecocokan untuk alamat jalan dan sebaliknya mengembalikan informasi untuk lebih dari satu nilai RoadBlock.
Nilai yang mungkin adalah:
Good: Lokasi hanya memiliki satu kecocokan atau semua kecocokan yang dikembalikan dianggap cocok dengan kuat. Misalnya, kueri untuk New York mengembalikan beberapa Kecocokan yang baik.
Ambiguous: Lokasi adalah salah satu dari sekumpulan kemungkinan kecocokan. Misalnya, ketika Anda mengkueri alamat jalan 128 Main St., respons dapat mengembalikan dua lokasi untuk 128 North Main St. dan 128 South Main St. karena tidak ada informasi yang cukup untuk menentukan opsi mana yang akan dipilih.
UpHierarchy: Lokasi mewakili pemindahan ke atas hierarki geografis. Ini terjadi ketika kecocokan untuk permintaan lokasi tidak ditemukan, sehingga hasil yang kurang tepat dikembalikan. Misalnya, jika kecocokan untuk alamat yang diminta tidak dapat ditemukan, maka kode kecocokan UpHierarchy dengan jenis entitas RoadBlock dapat dikembalikan.
| Nilai | Deskripsi |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| Nama | Jenis | Deskripsi |
|---|---|---|
| address |
Alamat hasil |
|
| confidence |
Tingkat keyakinan bahwa hasil lokasi yang dikodekan secara geografis adalah kecocokan. Gunakan nilai ini dengan kode kecocokan untuk menentukan informasi lebih lengkap tentang kecocokan. Keyakinan lokasi yang dikodekan secara geografis didasarkan pada banyak faktor termasuk kepentingan relatif dari lokasi yang dikodekan secara geografis dan lokasi pengguna, jika ditentukan. |
|
| geocodePoints |
Kumpulan titik geocode yang berbeda dalam cara penghitungannya dan penggunaan yang disarankan. |
|
| matchCodes |
Satu atau beberapa nilai kode yang cocok yang mewakili tingkat geocoding untuk setiap lokasi dalam respons. Misalnya, lokasi yang dikodekan secara geografis dengan kode kecocokan Demikian pula, lokasi yang dikodekan secara geografis dengan kode kecocokan Nilai yang mungkin adalah:
|
|
| type |
string |
Salah satu dari:
|
ReverseGeocodingResultTypeEnum
Tentukan jenis entitas yang Anda inginkan dalam respons. Hanya jenis yang Anda tentukan yang akan dikembalikan. Jika titik tidak dapat dipetakan ke jenis entitas yang Anda tentukan, tidak ada informasi lokasi yang dikembalikan dalam respons. Nilai default adalah semua entitas yang mungkin. Daftar jenis entitas yang dipisahkan koma yang dipilih dari opsi berikut.
- Alamat
- Lingkungan
- PopulatedPlace
- Kode pos1
- AdminDivision1
- AdminDivision2
- NegaraWilayah
Jenis entitas ini diurutkan dari entitas yang paling spesifik ke entitas yang paling tidak spesifik. Ketika entitas lebih dari satu jenis entitas ditemukan, hanya entitas yang paling spesifik yang dikembalikan. Misalnya, jika Anda menentukan Alamat dan AdminDistrict1 sebagai jenis entitas dan entitas yang ditemukan untuk kedua jenis, hanya informasi entitas Alamat yang dikembalikan dalam respons.
| Nilai | Deskripsi |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
UsageTypeEnum
Penggunaan terbaik untuk titik geocode.
Setiap titik geocode didefinisikan sebagai titik Route, titik Display atau keduanya.
Gunakan titik Route jika Anda membuat rute ke lokasi. Gunakan titik Display jika Anda menampilkan lokasi di peta. Misalnya, jika lokasinya adalah taman, titik Route dapat menentukan pintu masuk ke taman tempat Anda dapat masuk dengan mobil, dan titik Display mungkin merupakan titik yang menentukan pusat taman.
| Nilai | Deskripsi |
|---|---|
| Display | |
| Route |