Search - Get Search Address Reverse
A használatával lekérheti a földrajzi szélességi és hosszúsági koordinátákból származó utcacímet és helyadatokat.
Az Get Search Address Reverse
API és a HTTP-kérés GET
egy utcacímet vagy helyet ad vissza, ha megadja a szélességi és hosszúsági koordinátákat.
Előfordulhat, hogy egy koordinátát (például 37.786505, -122.3862) emberi közérthető címgé kell fordítania. Ez leggyakrabban olyan alkalmazások nyomon követéséhez szükséges, amelyekben GPS-hírcsatornát kap az eszköztől vagy eszköztől, és tudni szeretné, hogy a koordináták hol találhatók. Ez a végpont egy adott koordinátára vonatkozó címadatokat ad vissza.
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}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
format
|
path | True |
Response |
A válasz kívánt formátuma. Az érték lehet json vagy xml. |
api-version
|
query | True |
string |
Azure Maps API verziószáma. |
query
|
query | True |
number[] |
A megfelelő lekérdezés, amelyet vesszővel tagolt sztringként határoz meg, amelyet szélesség és hosszúság követ, például:"47.641268,-122.125679". |
allow
|
query |
boolean |
Az új vonalak formázása a formázott címben. Ha igaz, a cím új sorokat fog tartalmazni. Ha hamis, az új vonalak vesszővé lesznek konvertálva. |
|
entity
|
query |
Geographic |
A földrajzi helyeken végzett szűrés szintjét adja meg. Szűkíti a megadott földrajzi entitástípusok keresését, például csak a települést adja vissza. Az eredményként kapott válasz tartalmazza a földrajzi azonosítót és az entitástípust. Ha egynél több entitást ad meg vesszővel tagolt listaként, a végpont a "legkisebb elérhető entitást" adja vissza. A visszaadott geometria-azonosítóval lekérhető a földrajzi hely geometriája a Get Keresés Polygon API-val. A következő paraméterek figyelmen kívül lesznek hagyva az entityType beállításakor:
|
|
heading
|
query |
integer |
A jármű irányiránya fokban, az útszakaszon való utazáshoz. A 0 észak, a 90 a keleti és így tovább, az értékek -360 és 360 között mozognak. A pontosság legfeljebb egy tizedesjegyet tartalmazhat |
|
language
|
query |
string |
Az a nyelv, amelyben a keresési eredményeket vissza kell adni. A támogatott IETF nyelvcímkék egyikének kell lennie, a kis- és nagybetűk nem különböztethetők meg. Ha a megadott nyelvű adatok nem érhetők el egy adott mezőhöz, a rendszer az alapértelmezett nyelvet használja. Részletekért tekintse meg a támogatott nyelveket ismertető cikket. |
|
number
|
query |
string |
Utcaszám sztringként. Ha egy számot a kéréssel együtt küldenek be, a válasz tartalmazhatja az utca (balra/jobbra) oldalát, valamint az adott szám eltolási pozícióját is. |
|
radius
|
query |
integer |
Az eredmények meghatározott területre való korlátozásának mérőben megadott sugara |
|
return
|
query |
boolean |
Adja meg a válaszban elért geokódolónak megfelelő típusra vonatkozó információkat. |
|
return
|
query |
boolean |
Logikai. Az úthasználati tömb visszatérésének engedélyezése fordított geokódokhoz utcaszinten |
|
return
|
query |
boolean |
Logikai. A feladott sebességkorlát visszatérésének engedélyezése |
|
road
|
query |
Road |
A fordított geokódok bizonyos típusú közúti használatra való korlátozása. A fordított geokódok úthasználati tömbje lehet egy vagy több LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet |
|
view
|
query |
Localized |
A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók különböző nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen az alkalmazás által kiszolgálni kívánt ország/régió által megkövetelt nézetnek. Alapértelmezés szerint a View paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérelemben. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást, amely a kérelem IP-címe alapján adja vissza a térképadatokat. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN. A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
x-ms-client-id |
string |
Meghatározza, hogy melyik fiók legyen a Microsoft Entra ID biztonsági modellel együtt használva. Ez a Azure Maps fiók egyedi azonosítóját jelöli, és lekérhető a Azure Maps felügyeletisík Fiók API-jából. A Microsoft Entra ID biztonság Azure Maps az alábbi cikkekben talál útmutatást. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
Reverse |
OK |
Other Status Codes |
Error |
Váratlan hiba történt. |
Biztonság
AADToken
Ezek a Microsoft Entra OAuth 2.0-folyamatok. Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.
A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.
Megjegyzés
- Ez a biztonsági definíció megköveteli a fejléc használatát annak
x-ms-client-id
jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be. - A
Authorization URL
az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Microsoft Entra ID konfigurációkkal rendelkeznek. - Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
- A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.
- A Microsoft Identitásplatform kapcsolatos további információkért lásd: Microsoft Identitásplatform áttekintése.
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
Ez egy megosztott kulcs, amely akkor lesz kiépítve, ha Azure Maps fiókot hoz létre a Azure Portal vagy PowerShell, CLI, Azure SDK vagy REST API használatával.
Ezzel a kulccsal bármely alkalmazás hozzáférhet az összes REST API-hoz. Más szóval ez a kulcs használható főkulcsként abban a fiókban, amelyben ki vannak adva.
Nyilvánosan közzétett alkalmazások esetén javasoljuk, hogy a bizalmas ügyfélalkalmazások megközelítését használja Azure Maps REST API-k eléréséhez, hogy a kulcs biztonságosan tárolható legyen.
Type:
apiKey
In:
query
SAS Token
Ez egy közös hozzáférésű jogosultságkód-jogkivonat a listázási SAS műveletből jön létre az Azure Maps erőforráson keresztül az Azure felügyeleti síkján keresztül Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával.
Ezzel a jogkivonattal minden alkalmazás jogosult hozzáférni az Azure szerepköralapú hozzáférés-vezérlőihez, valamint az adott jogkivonathoz használt lejárati időhöz, sebességhez és régióhoz. Más szóval az SAS-jogkivonattal az alkalmazások a megosztott kulcsnál biztonságosabb módon szabályozhatják a hozzáférést.
Nyilvánosan közzétett alkalmazások esetében javasoljuk, hogy konfiguráljon egy adott listát az engedélyezett forrásokról a térképfiók-erőforráson a leképezési visszaélések korlátozásához és az SAS-jogkivonat rendszeres megújításához.
Type:
apiKey
In:
header
Példák
Searches addresses for coordinates 37.337,-121.89
Sample Request
GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89
Sample Response
{
"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"
}
]
}
Definíciók
Name | Description |
---|---|
Address |
Az eredmény címe |
Bounding |
A hely határolókerete. |
Entity |
A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval. |
Error |
Az erőforrás-kezelési hiba további információi. |
Error |
A hiba részletei. |
Error |
Hibaválasz |
Geographic |
Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető. |
Lat |
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon". |
Localized |
A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók eltérő nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen annak az országnak/régiónak, amelyet az alkalmazás használni fog. Alapértelmezés szerint a Nézet paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérésben. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást, amely a kérelem IP-címe alapján adja vissza a térképadatokat. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN. A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket. |
Match |
A fordított címkeresési művelethez tartozó egyezések típusai. |
Query |
A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR. |
Response |
A válasz kívánt formátuma. Az érték lehet json vagy xml. |
Reverse |
Ezt az objektumot egy sikeres Keresés Cím fordított hívása adja vissza |
Reverse |
Eredményobjektum egy Keresés cím fordított válaszához |
Road |
Az út lehetséges felhasználási területeit ismerteti. |
Search |
Egy Keresés API-válasz összefoglaló objektuma. |
Address
Az eredmény címe
Name | Típus | Description |
---|---|---|
boundingBox |
Bounding |
A hely határolókerete. |
buildingNumber |
string |
Az épület száma az utcán. ELAVULT, használja helyette a streetNumber parancsot. |
country |
string |
ország/régió neve |
countryCode |
string |
Country (Megjegyzés: Ez egy kétbetűs kód, nem ország/régió neve.) |
countryCodeISO3 |
string |
ISO alpha-3 országkód |
countrySecondarySubdivision |
string |
Megye |
countrySubdivision |
string |
Állam vagy tartomány |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
Az ország-/régiószintű felügyeleti hierarchia első szintjének teljes neve. Ez a mező csak abban az esetben jelenik meg, ha a countrySubdivision rövidített formában jelenik meg. Csak az USA, Kanada és az Egyesült Királyság esetében támogatott. |
countryTertiarySubdivision |
string |
Elnevezett terület |
crossStreet |
string |
A keresztezett utca neve. |
extendedPostalCode |
string |
Kiterjesztett irányítószám (a rendelkezésre állás a régiótól függ). |
freeformAddress |
string |
Az eredmény származási országának/régiójának formázási szabályai szerint formázott címsor, illetve ország/régió esetén annak teljes országának/régiójának neve. |
localName |
string |
Egy olyan címösszetevő, amely egy olyan földrajzi terület vagy hely nevét jelöli, amely több címezhető objektumot csoportosít címzés céljából, felügyeleti egység nélkül. Ez a mező a tulajdonság összeállítására |
municipality |
string |
Város / Város |
municipalitySubdivision |
string |
Al/Szuperváros |
neighbourhood |
string |
A szomszédság egy földrajzilag honosított terület egy városban vagy városban, amely megkülönböztető jellemzőkkel és társadalmi interakciókkal rendelkezik a lakosok között. |
postalCode |
string |
Irányítószám / Irányítószám |
routeNumbers |
string[] |
Az utca egyértelmű azonosítására használt kódok |
street |
string |
Az utcanév. ELAVULT, használja helyette a streetName nevet. |
streetName |
string |
Az utcanév. |
streetNameAndNumber |
string |
Az utcanév és a szám. |
streetNumber |
string |
Az épület száma az utcán. |
BoundingBoxCompassNotation
A hely határolókerete.
Name | Típus | Description |
---|---|---|
entity |
A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval. |
|
northEast |
string |
Észak-keleti szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt lebegőpontos lebegőpontosként |
southWest |
string |
Dél-nyugati szélesség, a határolókeret hosszúsági koordinátája vesszővel tagolt úszókként |
Entity
A határolókeret entitástípus-forrása. Fordított geokódolás esetén ez mindig egyenlő a pozícióval.
Name | Típus | Description |
---|---|---|
position |
string |
Pozíció entitás |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
Name | Típus | Description |
---|---|---|
info |
object |
A további információk. |
type |
string |
A további adattípus. |
ErrorDetail
A hiba részletei.
Name | Típus | Description |
---|---|---|
additionalInfo |
Error |
A hiba további információi. |
code |
string |
A hibakód. |
details |
Error |
A hiba részletei. |
message |
string |
A hibaüzenet. |
target |
string |
A hibacél. |
ErrorResponse
Hibaválasz
Name | Típus | Description |
---|---|---|
error |
Error |
A hibaobjektum. |
GeographicEntityType
Földrajzi entitás típusa. Csak akkor jelenik meg, ha az entityType kérése megtörtént, és elérhető.
Name | Típus | Description |
---|---|---|
Country |
string |
ország/régió neve |
CountrySecondarySubdivision |
string |
Megye |
CountrySubdivision |
string |
Állam vagy tartomány |
CountryTertiarySubdivision |
string |
Névvel ellátott terület |
Municipality |
string |
Város / Város |
MunicipalitySubdivision |
string |
Al/Szuperváros |
Neighbourhood |
string |
Szomszédságában |
PostalCodeArea |
string |
Irányítószám / Irányítószám |
LatLongPairAbbreviated
Földrajzi szélességként és hosszúságként jelölt hely, "lat" rövid nevek használatával & "lon".
Name | Típus | Description |
---|---|---|
lat |
number |
Latitude tulajdonság |
lon |
number |
Hosszúság tulajdonság |
LocalizedMapView
A View paraméter (más néven "felhasználói régió" paraméter) lehetővé teszi egy adott ország/régió megfelelő térképeinek megjelenítését a geopolitikailag vitatott régiókhoz. A különböző országok/régiók eltérő nézetekkel rendelkeznek az ilyen régiókról, és a Nézet paraméter lehetővé teszi, hogy az alkalmazás megfeleljen annak az országnak/régiónak, amelyet az alkalmazás használni fog. Alapértelmezés szerint a Nézet paraméter "Egyesített" értékre van állítva, még akkor is, ha még nem definiálta a kérésben. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. Másik lehetőségként beállíthatja a "View=Auto" beállítást, amely a kérelem IP-címe alapján adja vissza a térképadatokat. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. Példa: view=IN.
A részletekért tekintse meg a Támogatott nézetek című témakört , és tekintse meg az elérhető nézeteket.
Name | Típus | Description |
---|---|---|
AE |
string |
Egyesült Arab Emírségek (arab nézet) |
AR |
string |
Argentína (argentin nézet) |
Auto |
string |
Adja vissza a leképezési adatokat a kérelem IP-címe alapján. |
BH |
string |
Bahrein (arab nézet) |
IN |
string |
India (indiai nézet) |
IQ |
string |
Irak (arab nézet) |
JO |
string |
Jordánia (arab nézet) |
KW |
string |
Kuvait (arab nézet) |
LB |
string |
Libanon (arab nézet) |
MA |
string |
Marokkó (marokkói nézet) |
OM |
string |
Omán (arab nézet) |
PK |
string |
Pakisztán (pakisztáni nézet) |
PS |
string |
Palesztin Hatóság (arab nézet) |
QA |
string |
Katar (arab nézet) |
SA |
string |
Szaúd-Arábia (arab nézet) |
SY |
string |
Szíria (arab nézet) |
Unified |
string |
Egyesített nézet (egyéb) |
YE |
string |
Jemen (arab nézet) |
MatchType
A fordított címkeresési művelethez tartozó egyezések típusai.
Name | Típus | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
QueryType
A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR.
Name | Típus | Description |
---|---|---|
NEARBY |
string |
Keresés egy meghatározott sugarú szélesség és hosszúság körül végezték el |
NON_NEAR |
string |
Keresés globálisan végezték el, anélkül, hogy torzítanak egy bizonyos szélességre és hosszúságra, és nincs meghatározott sugár |
ResponseFormat
A válasz kívánt formátuma. Az érték lehet json vagy xml.
Name | Típus | Description |
---|---|---|
json |
string |
|
xml |
string |
ReverseSearchAddressResult
Ezt az objektumot egy sikeres Keresés Cím fordított hívása adja vissza
Name | Típus | Description |
---|---|---|
addresses |
Reverse |
Címtömb |
summary |
Search |
Egy Keresés cím fordított válaszának összegzési objektuma |
ReverseSearchAddressResultItem
Eredményobjektum egy Keresés cím fordított válaszához
Name | Típus | Description |
---|---|---|
address |
Az eredmény címe |
|
matchType |
Match |
Az egyezés típusára vonatkozó információk. Az alábbiak egyike:
|
position |
string |
Pozíció tulajdonság a következő formában: "{latitude},{longitude}" |
roadUse |
Road |
Az út lehetséges felhasználási területeit ismerteti. |
RoadUseType
Az út lehetséges felhasználási területeit ismerteti.
Name | Típus | Description |
---|---|---|
Arterial |
string |
|
LimitedAccess |
string |
|
LocalStreet |
string |
|
Ramp |
string |
|
Rotary |
string |
|
Terminal |
string |
SearchSummary
Egy Keresés API-válasz összefoglaló objektuma.
Name | Típus | Description |
---|---|---|
fuzzyLevel |
integer |
Az eredmények megadásához szükséges maximális fuzzy szint. |
geoBias |
Lat |
Annak jelzése, hogy a belső keresőmotor térinformatikai torzításokat alkalmazott az eredmények rangsorolásának javítására. Egyes metódusok ezt a lat és a lon paraméterek beállításával befolyásolhatják, ahol elérhető. Más esetekben ez tisztán belső. |
limit |
integer |
A visszaadott válaszok maximális száma |
numResults |
integer |
A válasz eredményeinek száma. |
offset |
integer |
A visszaadott eredmények kezdő eltolása a teljes eredménykészleten belül. |
query |
string |
A keresési eredmények előállításához használt lekérdezési paraméter. |
queryTime |
integer |
A lekérdezés feloldásával töltött idő ezredmásodpercben. |
queryType |
Query |
A visszaadott lekérdezés típusa: KÖZELI vagy NON_NEAR. |
totalResults |
integer |
A talált eredmények teljes száma. |