Bagikan melalui


Search - Get Search Address Reverse Cross Street

Gunakan untuk mendapatkan info lokasi lintas jalan dari koordinat garis lintang dan bujur.

API Get Search Address Reverse Cross Street adalah permintaan GET HTTP yang mengembalikan lintas jalan terdekat ketika diberikan koordinat garis lintang dan bujur. Mungkin ada kalanya Anda perlu menerjemahkan koordinat (misalnya: 37.786505, -122.3862) ke dalam lintas jalan yang dapat dimengerti manusia. Paling sering ini diperlukan dalam melacak aplikasi di mana Anda menerima umpan GPS dari perangkat atau aset dan ingin mengetahui alamat mana koordinat berada. Titik akhir ini akan mengembalikan informasi lintas jalan untuk koordinat tertentu.

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
format
path True

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml .

api-version
query True

string

Nomor versi Azure Maps API.

query
query True

number[]

Kueri yang berlaku ditentukan sebagai string yang dipisahkan koma yang terdiri dari garis lintang diikuti dengan garis bujur misalnya "47.641268,-122.125679".

heading
query

integer

minimum: -360
maximum: 360

Arah menuju kendaraan dalam derajat, untuk perjalanan di sepanjang segmen jalan. 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 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.

limit
query

integer

minimum: 1
maximum: 100

Jumlah maksimum respons yang akan dikembalikan. Default: 10, minimum: 1 dan maksimum: 100

radius
query

integer

Radius dalam meter ke untuk hasil yang akan dibatasi ke area yang ditentukan

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 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 merujuk ke 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 sarana manajemen Azure Maps. Untuk menggunakan keamanan ID Microsoft Entra di Azure Maps, lihat artikel berikut ini untuk panduan.

Respons

Nama Jenis Deskripsi
200 OK

ReverseSearchCrossStreetAddressResult

OK

Other Status Codes

ErrorResponse

Terjadi kesalahan tak terduga.

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-id untuk menunjukkan sumber daya Azure Maps mana yang diminta 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 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 Microsoft 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 dikeluarkan.

Untuk aplikasi yang diekspos secara publik, rekomendasi kami adalah menggunakan pendekatan aplikasi klien rahasia untuk mengakses REST API Azure Maps 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 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 address of the nearest intersection/crossroad

Permintaan sampel

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/json?api-version=1.0&query=37.337,-121.89

Respon sampel

{
  "summary": {
    "numResults": 1,
    "queryTime": 41
  },
  "addresses": [
    {
      "address": {
        "streetName": "East Santa Clara Street & North 2nd Street",
        "crossStreet": "East Santa Clara Street",
        "municipalitySubdivision": "San Jose, Downtown San Jose",
        "municipality": "San Jose",
        "countrySecondarySubdivision": "Santa Clara",
        "countryTertiarySubdivision": "San Jose",
        "countrySubdivisionCode": "CA",
        "postalCode": "95113",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
        "countrySubdivisionName": "California"
      },
      "position": "37.33666,-121.88951"
    }
  ]
}

Definisi

Nama Deskripsi
Address

Alamat hasil

BoundingBoxCompassNotation

Kotak pembatas lokasi.

Entity

Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Tanggapan kesalahan

LatLongPairAbbreviated

Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

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 merujuk ke Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

QueryType

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml .

ReverseSearchCrossStreetAddressResult

Objek ini dikembalikan dari panggilan Search Address Reverse CrossStreet yang berhasil

ReverseSearchCrossStreetAddressResultItem

Objek hasil untuk respons Reverse Cross Street Alamat Pencarian

SearchSummary

Objek ringkasan untuk respons SEARCH API.

Address

Alamat hasil

Nama Jenis Deskripsi
boundingBox

BoundingBoxCompassNotation

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

countrySubdivisionCode diawali oleh countryCode ( countryCode-countrySubdivisionCode ) dan tanda hubung membentuk kode ISO 3166-2. Contoh: TX untuk Texas, SCT untuk Skotlandia dan ON untuk Ontario.

countrySubdivisionName

string

Nama lengkap hierarki administratif negara/wilayah tingkat pertama. Bidang ini hanya muncul jika countrySubdivision disajikan dalam formulir 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 properti freeformAddress. localName mewakili kotamadya pos. Tergantung pada lokasinya, localName adalah nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, gunakan localName alih-alih municipality.

municipality

string

Kota/Kota
Catatan: municipality mewakili kotamadya perumahan. Tergantung pada lokasinya, nilai municipality mungkin berbeda dari nama kota atau kota yang umum dikenal. Untuk nama kota atau kota yang umum dikenal, disarankan agar nilai localName digunakan alih-alih nilai municipality.

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 mengidentifikasi jalan secara tidak ambigu

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

Entity

Sumber jenis entitas dari kotak pembatas. Untuk reverse-geocoding, ini selalu sama dengan posisi.

northEast

string

Garis lintang timur laut, 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.

Nilai Deskripsi
position

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

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ErrorResponse

Tanggapan kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

LatLongPairAbbreviated

Lokasi yang diwakili sebagai garis lintang dan bujur menggunakan nama pendek 'lat' & 'lon'.

Nama Jenis Deskripsi
lat

number (double)

Properti garis lintang

lon

number (double)

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 diizinkan untuk Anda akses melalui Azure Maps tersedia. Contoh: view=IN.

Silakan merujuk ke Tampilan yang Didukung untuk detailnya dan untuk melihat Tampilan yang tersedia.

Nilai Deskripsi
AE

Uni Emirat Arab (Tampilan Arab)

AR

Argentina (Pemandangan Argentina)

Auto

Mengembalikan data peta berdasarkan alamat IP permintaan.

BH

Bahrain (Tampilan Arab)

IN

India (Tampilan India)

IQ

Irak (Tampilan Arab)

JO

Yordania (Tampilan Arab)

KW

Kuwait (Tampilan Arab)

LB

Lebanon (Tampilan Arab)

MA

Maroko (Tampilan Maroko)

OM

Oman (Tampilan Arab)

PK

Pakistan (Tampilan Pakistan)

PS

Otoritas Palestina (Tampilan Arab)

QA

Qatar (Tampilan Arab)

SA

Arab Saudi (Tampilan Arab)

SY

Suriah (Tampilan Arab)

Unified

Tampilan Terpadu (Lainnya)

YE

Yaman (Tampilan Arab)

QueryType

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

Nilai Deskripsi
NEARBY

Pencarian dilakukan di sekitar garis lintang dan bujur tertentu dengan radius yang ditentukan

NON_NEAR

Pencarian dilakukan secara global, tanpa bias pada garis lintang dan bujur tertentu, dan tidak ada radius yang ditentukan

ResponseFormat

Format respons yang diinginkan. Nilai dapat berupa json atau xml .

Nilai Deskripsi
json

Format Pertukaran Data Notasi Objek JavaScript

xml

Bahasa Markup yang Dapat Diperluas

ReverseSearchCrossStreetAddressResult

Objek ini dikembalikan dari panggilan Search Address Reverse CrossStreet yang berhasil

Nama Jenis Deskripsi
addresses

ReverseSearchCrossStreetAddressResultItem[]

Array alamat

summary

SearchSummary

Objek ringkasan untuk respons Reverse Cross Street Alamat Pencarian

ReverseSearchCrossStreetAddressResultItem

Objek hasil untuk respons Reverse Cross Street Alamat Pencarian

Nama Jenis Deskripsi
address

Address

Alamat hasil

position

string

Properti posisi dalam bentuk "{garis lintang},{bujur}"

SearchSummary

Objek ringkasan untuk respons SEARCH API.

Nama Jenis Deskripsi
fuzzyLevel

integer

Tingkat fuzzy maksimum yang diperlukan untuk memberikan Hasil.

geoBias

LatLongPairAbbreviated

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 kumpulan Hasil lengkap.

query

string

Parameter kueri yang digunakan untuk menghasilkan hasil pencarian ini.

queryTime

integer

Waktu yang dihabiskan untuk menyelesaikan kueri, dalam milidetik.

queryType

QueryType

Jenis kueri yang dikembalikan: NEARBY atau NON_NEAR.

totalResults

integer

Jumlah total Hasil yang ditemukan.