Search - Get Reverse Geocoding
Använd för att hämta information om gatuadresser och platser från longitud- och latitudkoordinater.
API:et Get Reverse Geocoding
är en HTTP-begäran GET
som används för att översätta en koordinat (exempel: 37.786505, -122.3862) till en mänsklig begriplig gatuadress. Användbart för att spåra program där du får ett GPS-flöde från enheten eller tillgången och vill veta adressen som är associerad med koordinaterna. Den här slutpunkten returnerar adressinformation för en viss koordinat.
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}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Versionsnummer för Azure Maps API. |
coordinates
|
query | True |
number[] |
Koordinaterna för den plats där du vill omvänd geokoda. Exempel: &koordinater=lon,lat |
result
|
query |
Ange entitetstyper som du vill använda i svaret. Endast de typer som du anger returneras. Om punkten inte kan mappas till de entitetstyper som du anger returneras ingen platsinformation i svaret. Standardvärdet är alla möjliga entiteter. En kommaavgränsad lista över entitetstyper som valts från följande alternativ.
Dessa entitetstyper sorteras från den mest specifika entiteten till den minst specifika entiteten. När entiteter av mer än en entitetstyp hittas returneras endast den mest specifika entiteten. Om du till exempel anger Adress och AdminDistrict1 som entitetstyper och entiteter hittades för båda typerna returneras endast information om adressentitet i svaret. |
||
view
|
query |
string |
En sträng som representerar en ISO 3166-1 Alpha-2-region/landskod. Detta ändrar geopolitiska omtvistade kantlinjer och etiketter så att de överensstämmer med den angivna användarregionen. Som standard är view-parametern inställd på "Auto" även om du inte har definierat den i begäran. Mer information finns i Vyer som stöds och för att se tillgängliga vyer. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
x-ms-client-id |
string |
Anger vilket konto som är avsett för användning tillsammans med Azure AD-säkerhetsmodellen. Det representerar ett unikt ID för Azure Maps-kontot och kan hämtas från Konto-API:et för Azure Maps-hanteringsplan. Information om hur du använder Azure AD-säkerhet i Azure Maps finns i följande artiklar . |
|
Accept-Language |
string |
Språk där sökresultat ska returneras. Mer information finns i Språk som stöds . |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Det uppstod ett oväntat fel. Media Types: "application/geo+json" |
Säkerhet
AADToken
Det här är Microsoft Entra OAuth 2.0-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till REST-API:er för Azure Maps. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Rest-API:er för Azure Maps.
För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.
Anteckning
- Den här säkerhetsdefinitionen
x-ms-client-id
kräver att huvudet används för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et. -
Authorization URL
är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Microsoft Entra-ID-konfigurationer. - Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
- Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.
- Mer information om Microsofts identitetsplattform finns i Översikt över Microsofts identitetsplattform.
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Det här är en delad nyckel som etableras när du skapar en Azure Maps-resurs via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här nyckeln har alla program behörighet att komma åt alla REST-API:er. Med andra ord kan dessa för närvarande behandlas som huvudnycklar till det konto som de har utfärdats för.
För offentligt exponerade program rekommenderar vi att du använder server-till-server-åtkomst för Rest-API:er för Azure Maps där den här nyckeln kan lagras på ett säkert sätt.
Typ:
apiKey
I:
header
SAS Token
Det här är en signaturtoken för delad åtkomst som skapas från åtgärden List SAS på Azure Maps-resursen via Azure-hanteringsplanet via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er.
Med den här token har alla program behörighet att komma åt med rollbaserade Åtkomstkontroller i Azure och detaljerad kontroll av förfallodatum, frekvens och region för användning för den specifika token. Med andra ord kan SAS-token användas för att tillåta program att styra åtkomsten på ett säkrare sätt än den delade nyckeln.
För offentligt exponerade program rekommenderar vi att du konfigurerar en specifik lista över tillåtna ursprung på map-kontoresursen för att begränsa återgivningsmissbruket och regelbundet förnya SAS-token.
Typ:
apiKey
I:
header
Exempel
Search point -122.138681, 47.630358
Exempelbegäran
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-01&coordinates=-122.138681,47.630358
Exempelsvar
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
]
}
]
}
Definitioner
Name | Description |
---|---|
Address |
Resultatets adress |
Admin |
Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det också den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region. |
Calculation |
Den metod som användes för att beräkna geokodpunkten. |
Confidence |
Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om det anges. |
Country |
|
Error |
Ytterligare information om resurshanteringsfelet. |
Error |
Felinformationen. |
Error |
Felsvar |
Feature |
Typen av ett FeatureCollection-objekt måste vara FeatureCollection. |
Features |
|
Feature |
Typen av funktion måste vara Funktion. |
Geocode |
En samling geokodpunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning. |
Geocoding |
Det här objektet returneras från ett lyckat geokodningsanrop |
Geo |
En giltig |
Intersection |
Resultatets adress. |
Match |
Ett eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret. Till exempel innebär en geokodad plats med matchningskoder På samma sätt innebär en geokodad plats med matchningskoder Möjliga värden är:
|
Properties | |
Reverse |
Ange de entitetstyper som du vill använda i svaret. Endast de typer som du anger returneras. Om det inte går att mappa punkten till de entitetstyper som du anger returneras ingen platsinformation i svaret. Standardvärdet är alla möjliga entiteter. En kommaavgränsad lista över entitetstyper som valts från följande alternativ.
Dessa entitetstyper sorteras från den mest specifika entiteten till den minst specifika entiteten. När entiteter av mer än en entitetstyp hittas returneras endast den mest specifika entiteten. Om du till exempel anger Adress och AdminDistrict1 som entitetstyper och entiteter hittades för båda typerna returneras endast entitetsinformationen Adress i svaret. |
Usage |
Den bästa användningen för geokodpunkten.
Varje geokodpunkt definieras som en |
Address
Resultatets adress
Name | Typ | Description |
---|---|---|
addressLine |
string |
AddressLine som innehåller gatunamn och nummer |
adminDistricts |
Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det också den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region. |
|
countryRegion | ||
formattedAddress |
string |
Egenskapen Formaterad adress |
intersection |
Resultatets adress. |
|
locality |
string |
locality-egenskap |
neighborhood |
string |
grannskapsegenskap |
postalCode |
string |
Postnummeregenskap |
AdminDistricts
Underindelningsnamnet i landet eller regionen för en adress. Det här elementet behandlas vanligtvis som den administrativa underindelningen i första ordningen, men i vissa fall innehåller det också den andra, tredje eller fjärde ordningens underindelning i ett land, beroende eller en region.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på motsvarande adminDistrict-fält, För adminDistrict[0], kan detta vara fullständigt namn på delstaten, till exempel Washington, For adminDistrict[1], detta kan vara det fullständiga namnet på länet |
shortName |
string |
Det korta namnet för motsvarande adminDistrict-fält, För adminDistrict[0], kan detta vara ett kort namn på tillståndet, till exempel WA, For adminDistrict[1], detta kan vara det korta namnet på länet |
CalculationMethodEnum
Den metod som användes för att beräkna geokodpunkten.
Name | Typ | Description |
---|---|---|
Interpolation |
string |
Geokodpunkten matchades till en punkt på en väg med hjälp av interpolation. |
InterpolationOffset |
string |
Geokodpunkten matchades till en punkt på en väg med hjälp av interpolation med ytterligare en förskjutning för att flytta punkten till sidan av gatan. |
Parcel |
string |
Geokodpunkten matchades i mitten av ett paket. |
Rooftop |
string |
Geokodpunkten matchades mot taket i en byggnad. |
ConfidenceEnum
Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen.
Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om det anges.
Name | Typ | Description |
---|---|---|
High |
string |
Om konfidensen är inställd på Om en begäran innehåller en plats eller en vy kan rangordningen ändras på lämpligt sätt. En platsfråga för "Paris" returnerar till exempel "Paris, Frankrike" och "Paris, TX" båda med |
Low |
string |
|
Medium |
string |
I vissa situationer kanske den returnerade matchningen inte är på samma nivå som informationen i begäran. En begäran kan till exempel ange adressinformation och geokodstjänsten kanske bara kan matcha ett postnummer. I det här fallet, om geokodtjänsten har förtroende för att postnumret matchar data, är konfidensen inställd på Om platsinformationen i frågan är tvetydig och det inte finns någon ytterligare information för att rangordna platserna (till exempel användarplats eller platsens relativa betydelse) anges konfidensen till Om platsinformationen i frågan inte ger tillräckligt med information för att geokoda en specifik plats kan ett mindre exakt platsvärde returneras och konfidensen anges till |
CountryRegion
Name | Typ | Description |
---|---|---|
ISO |
string |
ISO för land/region |
name |
string |
namn på land/region |
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
Name | Typ | Description |
---|---|---|
info |
object |
Den ytterligare informationen. |
type |
string |
Ytterligare informationstyp. |
ErrorDetail
Felinformationen.
Name | Typ | Description |
---|---|---|
additionalInfo |
Ytterligare information om felet. |
|
code |
string |
Felkoden. |
details |
Felinformationen. |
|
message |
string |
Felmeddelandet. |
target |
string |
Felmålet. |
ErrorResponse
Felsvar
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
FeatureCollectionEnum
Typen av ett FeatureCollection-objekt måste vara FeatureCollection.
Name | Typ | Description |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946 . |
geometry |
En giltig |
|
id |
string |
ID för funktionen som returneras |
properties | ||
type |
Typen av funktion måste vara Funktion. |
FeatureTypeEnum
Typen av funktion måste vara Funktion.
Name | Typ | Description |
---|---|---|
Feature |
string |
GeocodePoints
En samling geokodpunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning.
Name | Typ | Description |
---|---|---|
calculationMethod |
Den metod som användes för att beräkna geokodpunkten. |
|
geometry |
En giltig |
|
usageTypes |
Den bästa användningen för geokodpunkten.
Varje geokodpunkt definieras som en |
GeocodingResponse
Det här objektet returneras från ett lyckat geokodningsanrop
Name | Typ | Description |
---|---|---|
features | ||
nextLink |
string |
är länken till nästa sida i de funktioner som returneras. Om det är den sista sidan, nej det här fältet. |
type |
Typen av ett FeatureCollection-objekt måste vara FeatureCollection. |
GeoJsonPoint
En giltig GeoJSON Point
geometrityp. Mer information finns i RFC 7946 .
Name | Typ | Description |
---|---|---|
bbox |
number[] |
Markeringsramen. Projektion används – EPSG:3857. Mer information finns i RFC 7946 . |
coordinates |
number[] |
A |
type |
string:
Point |
Anger |
Intersection
Resultatets adress.
Name | Typ | Description |
---|---|---|
baseStreet |
string |
Primär gata för platsen. |
displayName |
string |
Fullständigt namn på skärningspunkten. |
intersectionType |
string |
Typ av skärningspunkt. |
secondaryStreet1 |
string |
Den första korsande gatan. |
secondaryStreet2 |
string |
Om någon, den andra korsar gatan. |
MatchCodesEnum
Ett eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret.
Till exempel innebär en geokodad plats med matchningskoder Good
och Ambiguous
att mer än en geokodsplats hittades för platsinformationen och att geokodtjänsten inte hade någon sökning uppåt-hierarki för att hitta en matchning.
På samma sätt innebär en geokodad plats med matchningskoder Ambiguous
och UpHierarchy
att det inte gick att hitta en geokodplats som matchade all angiven platsinformation, så geokodtjänsten var tvungen att söka i upphierarkin och hitta flera matchningar på den nivån. Ett exempel på ett Ambiguous
och-resultat UpHierarchy
är när du anger fullständig adressinformation, men geokodstjänsten inte kan hitta en matchning för gatuadressen och i stället returnerar information för mer än ett RoadBlock-värde.
Möjliga värden är:
Good
: Platsen har bara en matchning eller alla returnerade matchningar anses vara starka matchningar. En fråga för New York returnerar till exempel flera bra matchningar.
Ambiguous
: Platsen är en av en uppsättning möjliga matchningar. När du till exempel frågar efter gatuadressen 128 Main St., kan svaret returnera två platser för 128 North Main St. och 128 South Main St. eftersom det inte finns tillräckligt med information för att avgöra vilket alternativ som ska väljas.
UpHierarchy
: Platsen representerar en flytt uppåt i den geografiska hierarkin. Detta inträffar när en matchning för platsbegäran inte hittades, så ett mindre exakt resultat returneras. Om det till exempel inte går att hitta en matchning för den begärda adressen kan en matchningskod UpHierarchy
för med en RoadBlock-entitetstyp returneras.
Name | Typ | Description |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Name | Typ | Description |
---|---|---|
address |
Resultatets adress |
|
confidence |
Konfidensnivån för resultatet av den geokodade platsen är en matchning. Använd det här värdet med matchningskoden för att fastställa mer fullständig information om matchningen. Konfidensen för en geokodad plats baseras på många faktorer, inklusive den relativa betydelsen av den geokodade platsen och användarens plats, om det anges. |
|
geocodePoints |
En samling geokodningspunkter som skiljer sig åt i hur de beräknades och deras föreslagna användning. |
|
matchCodes |
Ett eller flera matchningskodvärden som representerar geokodningsnivån för varje plats i svaret. Till exempel innebär en geokodad plats med matchningskoder På samma sätt innebär en geokodad plats med matchningskoder Möjliga värden är:
|
|
type |
string |
Något av:
|
ReverseGeocodingResultTypeEnum
Ange de entitetstyper som du vill använda i svaret. Endast de typer som du anger returneras. Om det inte går att mappa punkten till de entitetstyper som du anger returneras ingen platsinformation i svaret. Standardvärdet är alla möjliga entiteter. En kommaavgränsad lista över entitetstyper som valts från följande alternativ.
- Adress
- Grannskap
- PopulatedPlace
- Postkod1
- AdminDivision1
- AdminDivision2
- CountryRegion
Dessa entitetstyper sorteras från den mest specifika entiteten till den minst specifika entiteten. När entiteter av mer än en entitetstyp hittas returneras endast den mest specifika entiteten. Om du till exempel anger Adress och AdminDistrict1 som entitetstyper och entiteter hittades för båda typerna returneras endast entitetsinformationen Adress i svaret.
Name | Typ | Description |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
Den bästa användningen för geokodpunkten.
Varje geokodpunkt definieras som en Route
punkt, en Display
punkt eller båda.
Använd Route
punkter om du skapar en väg till platsen. Använd Display
punkter om du visar platsen på en karta. Om platsen till exempel är en park kan en Route
punkt ange en ingång till parken där du kan komma in med en bil, och en Display
punkt kan vara en punkt som anger mitten av parken.
Name | Typ | Description |
---|---|---|
Display |
string |
|
Route |
string |