Search - Get Reverse Geocoding
Slouží k získání adresy ulice a informací o poloze ze souřadnic zeměpisné délky a zeměpisné šířky.
Rozhraní Get Reverse Geocoding
API je požadavek HTTP GET
, který se používá k překladu souřadnic (příklad: 37.786505, -122.3862) na srozumitelnou adresu. Užitečné při sledování aplikací, kde přijímáte informační kanál GPS ze zařízení nebo prostředku a chcete znát adresu spojenou se souřadnicemi. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates={coordinates}&resultTypes={resultTypes}&view={view}
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Číslo verze rozhraní API služby Azure Maps |
coordinates
|
query | True |
number[] |
Souřadnice umístění, které chcete převrátit do geografického kódu. Příklad: &souřadnice=lon,lat |
result
|
query |
Zadejte typy entit, které chcete použít v odpovědi. Budou vráceny pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, nebudou v odpovědi vráceny žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností
Tyto typy entit jsou seřazené od nejkonsekvnější po nejméně konkrétní entitu. Pokud jsou nalezeny entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například jako typy entit zadáte Address a AdminDistrict1 a pro oba typy byly nalezeny entity, vrátí se v odpovědi pouze informace o entitě Adresa. |
||
view
|
query |
string |
Řetězec, který představuje kód oblasti/země ISO 3166-1 Alpha-2. Tím se změní geopolitické sporné ohraničení a popisky tak, aby odpovídaly zadané oblasti uživatele. Ve výchozím nastavení je parametr View nastavený na "Auto", i když jste ho v požadavku nedefinoval. Podrobnosti a dostupná zobrazení najdete v části Podporovaná zobrazení. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Určuje, který účet je určený pro použití ve spojení s modelem zabezpečení Azure AD. Představuje jedinečné ID účtu Azure Maps a dá se načíst z rozhraní API účtu roviny správy Služby Azure Maps. Informace o použití zabezpečení Azure AD ve službě Azure Maps najdete v následujících článcích . |
|
Accept-Language |
string |
Jazyk, ve kterém se mají vracet výsledky hledání. Podrobnosti najdete v části Podporované jazyky . |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Došlo k neočekávané chybě. Media Types: "application/geo+json" |
Zabezpečení
AADToken
Toto jsou toky Microsoft Entra OAuth 2.0 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k rozhraním REST API služby Azure Maps. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika účtům prostředků nebo dílčím prostředkům Azure Maps. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role, která se skládá z jednoho nebo více oprávnění k rozhraním REST API služby Azure Maps.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu k určitým rozhraním API a oborům.
Poznámka
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení prostředku Azure Maps, ke kterému aplikace žádá o přístup. To je možné získat z rozhraní API pro správu map. - Je
Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Microsoft Entra ID. - Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
- Použití webové sady SDK služby Azure Maps umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Další informace o platformě Microsoft Identity Platform najdete v tématu Přehled platformy Microsoft Identity Platform.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Toto je sdílený klíč, který se zřizuje při vytváření prostředku Azure Maps prostřednictvím roviny správy Azure prostřednictvím webu Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto klíčem má každá aplikace oprávnění pro přístup ke všem rozhraním REST API. Jinými slovy, ty je v současné době možné považovat za hlavní klíče k účtu, pro který jsou vystaveny.
U veřejně vystavených aplikací doporučujeme používat přístup mezi servery k rozhraním REST API služby Azure Maps, kde je možné tento klíč bezpečně uložit.
Typ:
apiKey
V:
header
SAS Token
Jedná se o token sdíleného přístupového podpisu, který se vytvoří z operace List SAS v prostředku Azure Maps prostřednictvím roviny správy Azure portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
S tímto tokenem má každá aplikace oprávnění k přístupu pomocí řízení přístupu na základě role v Azure a podrobného řízení k vypršení platnosti, četnosti a oblastem použití konkrétního tokenu. Jinými slovy, token SAS je možné použít k tomu, aby aplikace mohly řídit přístup bezpečnějším způsobem než sdílený klíč.
U veřejně vystavených aplikací doporučujeme nakonfigurovat konkrétní seznam povolených zdrojů v prostředku mapového účtu , aby se omezilo zneužití vykreslování a pravidelně obnovovali token SAS.
Typ:
apiKey
V:
header
Příklady
Search point -122.138681, 47.630358
Ukázkový požadavek
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=-122.138681,47.630358
Ukázková odpověď
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"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
]
}
]
}
Definice
Name | Description |
---|---|
Address |
Adresa výsledku |
Admin |
Název dílčího dělení v zemi nebo oblasti pro adresu. Tento prvek se obvykle považuje za správní pododdíl prvního řádu, ale v některých případech obsahuje také pododdíl druhého, třetího nebo čtvrtého pořadí v zemi, závislosti nebo oblasti. |
Calculation |
Metoda, která se použila k výpočtu bodu geografického kódu. |
Confidence |
Úroveň spolehlivosti, kterou výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte spolu s kódem shody k určení úplnějších informací o shodě. Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geograficky zakódovaného umístění a polohy uživatele, pokud je zadána. |
Country |
|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Feature |
Typ FeatureCollection objektu musí být FeatureCollection. |
Features |
|
Feature |
Typ funkce musí být Funkce. |
Geocode |
Kolekce bodů geografického kódu, které se liší ve způsobu jejich výpočtu a navrhovaném použití. |
Geocoding |
Tento objekt se vrátí z úspěšného volání geokódování. |
Geo |
Platný |
Intersection |
Adresa výsledku. |
Match |
Jedna nebo více hodnot kódu shody, které představují úroveň geografického kódování pro každé umístění v odpovědi. Například geokódované umístění s odpovídajícími kódy Podobně geograficky zakódované umístění s kódy shody a Možné hodnoty jsou:
|
Properties | |
Reverse |
Zadejte typy entit, které chcete v odpovědi použít. Vrátí se pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, v odpovědi se nevrátí žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností
Tyto typy entit jsou seřazené od nejkonsekvnější entity k nejméně konkrétní entitě. Pokud se najdou entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například zadáte Address a AdminDistrict1 jako typy entit a entity byly nalezeny pro oba typy, vrátí se v odpovědi pouze informace o entitě Adresa. |
Usage |
Nejlepší použití pro bod geografického kódu.
Každý bod geografického |
Address
Adresa výsledku
Name | Typ | Description |
---|---|---|
addressLine |
string |
AddressLine, která obsahuje název ulice a číslo |
adminDistricts |
Název dílčího dělení v zemi nebo oblasti pro adresu. Tento prvek se obvykle považuje za správní pododdíl prvního řádu, ale v některých případech obsahuje také pododdíl druhého, třetího nebo čtvrtého pořadí v zemi, závislosti nebo oblasti. |
|
countryRegion | ||
formattedAddress |
string |
Vlastnost Formátovaná adresa |
intersection |
Adresa výsledku. |
|
locality |
string |
lokalita – vlastnost |
neighborhood |
string |
sousedská vlastnost |
postalCode |
string |
Vlastnost PSČ |
AdminDistricts
Název dílčího dělení v zemi nebo oblasti pro adresu. Tento prvek se obvykle považuje za správní pododdíl prvního řádu, ale v některých případech obsahuje také pododdíl druhého, třetího nebo čtvrtého pořadí v zemi, závislosti nebo oblasti.
Name | Typ | Description |
---|---|---|
name |
string |
Název odpovídajícího pole adminDistrict For adminDistrict[0], může to být úplný název státu, například Washington, For adminDistrict[1], může to být úplný název okresu. |
shortName |
string |
Krátký název odpovídajícího pole adminDistrict For adminDistrict[0], může to být krátký název státu, například WA, Pro adminDistrict[1], může to být krátký název okresu. |
CalculationMethodEnum
Metoda, která se použila k výpočtu bodu geografického kódu.
Name | Typ | Description |
---|---|---|
Interpolation |
string |
Bod geografického kódu byl spárován s bodem na silnici pomocí interpolace. |
InterpolationOffset |
string |
Bod geokódu byl spárován s bodem na silnici pomocí interpolace s dodatečným posunem, aby se bod přesunul na stranu ulice. |
Parcel |
string |
Bod geokódu byl spárován se středem parcely. |
Rooftop |
string |
Bod geokódu byl spárován se střechou budovy. |
ConfidenceEnum
Úroveň spolehlivosti, kterou výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte spolu s kódem shody k určení úplnějších informací o shodě.
Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geograficky zakódovaného umístění a polohy uživatele, pokud je zadána.
Name | Typ | Description |
---|---|---|
High |
string |
Pokud je hodnota spolehlivosti nastavená na Pokud žádost obsahuje umístění nebo zobrazení, může se pořadí odpovídajícím způsobem změnit. Například dotaz na umístění pro "Paříž" vrátí "Paříž, Francie" i "Paříž, TX" oba s |
Low |
string |
|
Medium |
string |
V některých situacích nemusí být vrácená shoda na stejné úrovni jako informace uvedené v požadavku. Požadavek může například zadat informace o adrese a služba geografického kódu může odpovídat pouze PSČ. Pokud má v tomto případě služba geografického kódu jistotu, že PSČ odpovídá datům, je nastavena hodnota Pokud jsou informace o poloze v dotazu nejednoznačné a nejsou k dispozici žádné další informace k řazení umístění (například umístění uživatele nebo relativní důležitost umístění), je spolehlivost nastavená na Pokud informace o poloze v dotazu neposkytují dostatek informací ke geografickému kódování konkrétního umístění, může se vrátit méně přesná hodnota polohy a spolehlivost je nastavená na |
CountryRegion
Name | Typ | Description |
---|---|---|
ISO |
string |
ISO země/oblasti |
name |
string |
název země/oblasti |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
FeatureCollectionEnum
Typ FeatureCollection objektu musí být FeatureCollection.
Name | Typ | Description |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
geometry |
Platný |
|
id |
string |
ID vrácené funkce |
properties | ||
type |
Typ funkce musí být Funkce. |
FeatureTypeEnum
Typ funkce musí být Funkce.
Name | Typ | Description |
---|---|---|
Feature |
string |
GeocodePoints
Kolekce bodů geografického kódu, které se liší ve způsobu jejich výpočtu a navrhovaném použití.
Name | Typ | Description |
---|---|---|
calculationMethod |
Metoda, která se použila k výpočtu bodu geografického kódu. |
|
geometry |
Platný |
|
usageTypes |
Nejlepší použití pro bod geografického kódu.
Každý bod geografického |
GeocodingResponse
Tento objekt se vrátí z úspěšného volání geokódování.
Name | Typ | Description |
---|---|---|
features | ||
nextLink |
string |
Je odkaz na další stránku vrácených funkcí. Pokud se jedná o poslední stránku, toto pole není. |
type |
Typ FeatureCollection objektu musí být FeatureCollection. |
GeoJsonPoint
Platný GeoJSON Point
typ geometrie. Podrobnosti najdete v dokumentu RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Ohraničující rámeček. Použitá projekce - EPSG:3857. Podrobnosti najdete v dokumentu RFC 7946 . |
coordinates |
number[] |
A |
type |
string:
Point |
Určuje |
Intersection
Adresa výsledku.
Name | Typ | Description |
---|---|---|
baseStreet |
string |
Primární ulice pro umístění. |
displayName |
string |
Úplný název průsečíku |
intersectionType |
string |
Typ průsečíku. |
secondaryStreet1 |
string |
První protínající se ulice. |
secondaryStreet2 |
string |
Pokud existuje, druhá protínající se ulice. |
MatchCodesEnum
Jedna nebo více hodnot kódu shody, které představují úroveň geografického kódování pro každé umístění v odpovědi.
Například geokódované umístění s odpovídajícími kódy Good
a Ambiguous
znamená, že pro informace o poloze bylo nalezeno více než jedno umístění geografického kódu a že služba geografického kódu neměla vyhledávání v hierarchii, aby našla shodu.
Podobně geograficky zakódované umístění s kódy shody a UpHierarchy
znamená, že nebylo nalezeno umístění geografického Ambiguous
kódu, které by odpovídalo všem zadaným informacím o poloze, takže služba geografického kódu musela vyhledat hierarchii a najít více shod na této úrovni. Příklad výsledku Ambiguous
a UpHierarchy
je, když zadáte úplné informace o adrese, ale služba geografického kódu nemůže najít shodu pro adresu a místo toho vrátí informace pro více než jednu hodnotu RoadBlock.
Možné hodnoty jsou:
Good
: Umístění má pouze jednu shodu nebo všechny vrácené shody jsou považovány za silné shody. Například dotaz pro New York vrátí několik dobrých shod.
Ambiguous
: Umístění je jednou ze sady možných shod. Například při dotazu na adresu ulice 128 Main St. může odpověď vrátit dvě umístění pro 128 North Main St. a 128 South Main St., protože není k dispozici dostatek informací k určení, kterou možnost zvolit.
UpHierarchy
: Umístění představuje přesun v geografické hierarchii nahoru. K tomu dochází v případě, že nebyla nalezena shoda pro žádost o umístění, takže se vrátí méně přesný výsledek. Pokud například nelze najít shodu pro požadovanou adresu, může být vrácen kód UpHierarchy
shody s typem entity RoadBlock.
Name | Typ | Description |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Name | Typ | Description |
---|---|---|
address |
Adresa výsledku |
|
confidence |
Úroveň spolehlivosti, kterou výsledek geokódovaného umístění odpovídá. Tuto hodnotu použijte spolu s kódem shody k určení úplnějších informací o shodě. Spolehlivost geokódovaného umístění je založená na mnoha faktorech, včetně relativní důležitosti geograficky zakódovaného umístění a polohy uživatele, pokud je zadána. |
|
geocodePoints |
Kolekce bodů geografického kódu, které se liší ve způsobu jejich výpočtu a navrhovaném použití. |
|
matchCodes |
Jedna nebo více hodnot kódu shody, které představují úroveň geografického kódování pro každé umístění v odpovědi. Například geokódované umístění s odpovídajícími kódy Podobně geograficky zakódované umístění s kódy shody a Možné hodnoty jsou:
|
|
type |
string |
Jedna z těchto možností:
|
ReverseGeocodingResultTypeEnum
Zadejte typy entit, které chcete v odpovědi použít. Vrátí se pouze typy, které zadáte. Pokud bod nelze mapovat na typy entit, které zadáte, v odpovědi se nevrátí žádné informace o poloze. Výchozí hodnota jsou všechny možné entity. Seznam typů entit oddělených čárkami vybraných z následujících možností
- Adresa
- Sousedství
- Vyplněné místo
- PSČ1
- AdminDivision1
- AdminDivision2
- CountryRegion
Tyto typy entit jsou seřazené od nejkonsekvnější entity k nejméně konkrétní entitě. Pokud se najdou entity s více než jedním typem entity, vrátí se pouze nejkonvičtější entita. Pokud například zadáte Address a AdminDistrict1 jako typy entit a entity byly nalezeny pro oba typy, vrátí se v odpovědi pouze informace o entitě Adresa.
Name | Typ | Description |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
Nejlepší použití pro bod geografického kódu.
Každý bod geografického Route
kódu je definován jako bod, Display
bod nebo obojí.
Pokud vytváříte trasu do umístění, použijte Route
body. Pokud zobrazujete polohu na mapě, použijte Display
body. Pokud je například místem park, může bod určit vstup do parku, Route
kam můžete vstoupit autem, a Display
bod může být bod, který určuje střed parku.
Name | Typ | Description |
---|---|---|
Display |
string |
|
Route |
string |