Search - Get Reverse Geocoding
Úselo para obtener información sobre la dirección y la ubicación de las coordenadas de longitud y latitud.
La API de Get Reverse Geocoding es una solicitud de GET HTTP que se usa para traducir una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible humana. Resulta útil en el seguimiento de aplicaciones en las que recibe una fuente GPS del dispositivo o recurso y desea conocer la dirección asociada a las coordenadas. Este punto de conexión devolverá información de dirección para una coordenada determinada.
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}
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número de versión de la API de Azure Maps. |
|
coordinates
|
query | True |
number[] |
Coordenadas de la ubicación en la que desea invertir el código geográfico. Ejemplo: &coordinates=lon,lat |
|
result
|
query |
Especifique los tipos de entidad que desee en la respuesta. Solo se devolverán los tipos que especifique. Si el punto no se puede asignar a los tipos de entidad especificados, no se devuelve información de ubicación en la respuesta. El valor predeterminado es todas las entidades posibles. Lista separada por comas de tipos de entidad seleccionados de las siguientes opciones.
Estos tipos de entidad se ordenan de la entidad más específica a la entidad menos específica. Cuando se encuentran entidades de más de un tipo de entidad, solo se devuelve la entidad más específica. Por ejemplo, si especifica Address y AdminDistrict1 como tipos de entidad y entidades se encontraron para ambos tipos, solo se devuelve la información de la entidad Address en la respuesta. |
||
|
view
|
query |
string |
Cadena que representa un código ISO 3166-1 Alpha-2 region/country. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. De forma predeterminada, el parámetro View se establece en "Auto" incluso si no lo ha definido en la solicitud. Consulte vistas admitidas para obtener más información y ver las vistas disponibles. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Azure AD. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para obtener más información sobre el uso de la seguridad de ID de Microsoft Entra en Azure Maps, consulte Administración de la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Idioma en el que se deben devolver los resultados de la búsqueda. Consulte idiomas admitidos para obtener más información. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
De acuerdo Media Types: "application/geo+json" |
|
| Other Status Codes |
Error inesperado. Media Types: "application/geo+json" |
Seguridad
AADToken
Estos son los flujos de Microsoft Entra OAuth 2.0. Cuando se empareja con acceso basado en rol de Azure control, se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio a través de un rol integrado o de un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.
Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.
Nota:
- Esta definición de seguridad requiere el uso del encabezado para indicar a qué recurso de
x-ms-client-idAzure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps. - El
Authorization URLes específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. - El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.
- El uso de SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
- Para obtener más información sobre la plataforma de identidad de Microsoft, consulte introducción a la plataforma de identidad de Microsoft.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Se trata de una clave compartida que se aprovisiona al crear una recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.
Para las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.
Tipo:
apiKey
En:
header
SAS Token
Se crea un token de firma de acceso compartido a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
Con este token, cualquier aplicación tiene autorización para acceder a los controles de acceso basados en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle el acceso de forma más segura que la clave compartida.
En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.
Tipo:
apiKey
En:
header
Ejemplos
Search point -122.138681, 47.630358
Solicitud de ejemplo
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
Respuesta de muestra
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
]
}
]
}
Definiciones
| Nombre | Description |
|---|---|
| Address |
Dirección del resultado |
|
Admin |
Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región. |
|
Calculation |
Método que se usó para calcular el punto de código geográfico. |
|
Confidence |
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica. |
|
Country |
|
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error |
|
Feature |
El tipo de un objeto FeatureCollection debe ser FeatureCollection. |
|
Features |
|
|
Feature |
El tipo de una característica debe ser Característica. |
|
Geocode |
Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido. |
|
Geocoding |
Este objeto se devuelve de una llamada de geocodificación correcta. |
|
Geo |
Un tipo de geometría |
| Intersection |
Dirección del resultado. |
|
Match |
Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta. Por ejemplo, una ubicación con codificación geográfica con códigos de coincidencia de Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Los valores posibles son:
|
| Properties | |
|
Reverse |
Especifique los tipos de entidad que desee en la respuesta. Solo se devolverán los tipos que especifique. Si el punto no se puede asignar a los tipos de entidad especificados, no se devuelve información de ubicación en la respuesta. El valor predeterminado es todas las entidades posibles. Lista separada por comas de tipos de entidad seleccionados de las siguientes opciones.
Estos tipos de entidad se ordenan de la entidad más específica a la entidad menos específica. Cuando se encuentran entidades de más de un tipo de entidad, solo se devuelve la entidad más específica. Por ejemplo, si especifica Address y AdminDistrict1 como tipos de entidad y entidades se encontraron para ambos tipos, solo se devuelve la información de la entidad Address en la respuesta. |
|
Usage |
El mejor uso para el punto de código geográfico.
Cada punto de código geográfico se define como punto de |
Address
Dirección del resultado
| Nombre | Tipo | Description |
|---|---|---|
| addressLine |
string |
AddressLine que incluye nombre de calle y número |
| adminDistricts |
Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región. |
|
| countryRegion | ||
| formattedAddress |
string |
Propiedad Address con formato |
| intersection |
Dirección del resultado. |
|
| locality |
string |
locality (propiedad) |
| neighborhood |
string |
propiedad del vecindario |
| postalCode |
string |
Propiedad Código postal |
| streetName |
string |
El nombre de la calle de formattedAddress |
| streetNumber |
string |
El número en la calle, si está disponible, de formattedAddress |
AdminDistricts
Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
El nombre del campo adminDistrict correspondiente, Para adminDistrict[0], este podría ser el nombre completo del estado, como Washington, For adminDistrict[1], podría ser el nombre completo del condado. |
| shortName |
string |
El nombre corto del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser un nombre corto de estado como WA, For adminDistrict[1], podría ser el nombre corto del condado. |
CalculationMethodEnum
Método que se usó para calcular el punto de código geográfico.
| Valor | Description |
|---|---|
| Interpolation |
El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación. |
| InterpolationOffset |
El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación con un desplazamiento adicional para desplazar el punto al lado de la calle. |
| Parcel |
El punto de geocodificación se ha hecho coincidir con el centro de una parcela. |
| Rooftop |
El punto de geocodificación se hizo coincidir con la azotea de un edificio. |
ConfidenceEnum
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia.
La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.
| Valor | Description |
|---|---|
| High |
Si la confianza se establece en Si una solicitud incluye una ubicación o una vista, la clasificación puede cambiar adecuadamente. Por ejemplo, una consulta de ubicación para "París" devuelve "París, Francia" y "París, TX" con |
| Medium |
En algunas situaciones, es posible que la coincidencia devuelta no esté al mismo nivel que la información proporcionada en la solicitud. Por ejemplo, una solicitud puede especificar información de dirección y es posible que el servicio de geocodificación solo pueda coincidir con un código postal. En este caso, si el servicio de geocodificación tiene la confianza de que el código postal coincide con los datos, la confianza se establece en Si la información de ubicación de la consulta es ambigua y no hay información adicional para clasificar las ubicaciones (como la ubicación del usuario o la importancia relativa de la ubicación), la confianza se establece en Si la información de ubicación de la consulta no proporciona suficiente información para geocodificar una ubicación específica, es posible que se devuelva un valor de ubicación menos preciso y la confianza se establezca en |
| Low |
CountryRegion
| Nombre | Tipo | Description |
|---|---|---|
| ISO |
string |
ISO del país o región |
| name |
string |
nombre del país o región |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
FeatureCollectionEnum
El tipo de un objeto FeatureCollection debe ser FeatureCollection.
| Valor | Description |
|---|---|
| FeatureCollection |
FeaturesItem
FeatureTypeEnum
El tipo de una característica debe ser Característica.
| Valor | Description |
|---|---|
| Feature |
GeocodePoints
Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido.
GeocodingResponse
Este objeto se devuelve de una llamada de geocodificación correcta.
| Nombre | Tipo | Description |
|---|---|---|
| features | ||
| nextLink |
string |
es el vínculo a la página siguiente de las características devueltas. Si es la última página, no hay este campo. |
| type |
El tipo de un objeto FeatureCollection debe ser FeatureCollection. |
GeoJsonPoint
Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.
Intersection
Dirección del resultado.
| Nombre | Tipo | Description |
|---|---|---|
| baseStreet |
string |
Calle principal para la ubicación. |
| displayName |
string |
Nombre completo de la intersección. |
| intersectionType |
string |
Tipo de intersección. |
| secondaryStreet1 |
string |
La primera intersección de la calle. |
| secondaryStreet2 |
string |
Si existe, la segunda calle que interseca. |
MatchCodesEnum
Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta.
Por ejemplo, una ubicación con codificación geográfica con códigos de coincidencia de Good y Ambiguous significa que se encontró más de una ubicación de código geográfico para la información de ubicación y que el servicio de geocódigo no tenía la jerarquía de búsqueda para encontrar una coincidencia.
Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Ambiguous y UpHierarchy implica que no se encontró una ubicación de código geográfico que coincida con toda la información de ubicación proporcionada, por lo que el servicio de geocódigo tenía que buscar en la jerarquía superior y encontrar varias coincidencias en ese nivel. Un ejemplo de un Ambiguous y UpHierarchy resultado es cuando se proporciona información de dirección completa, pero el servicio de código geográfico no puede encontrar una coincidencia para la dirección postal y, en su lugar, devuelve información para más de un valor RoadBlock.
Los valores posibles son:
Good: la ubicación solo tiene una coincidencia o todas las coincidencias devueltas se consideran coincidencias seguras. Por ejemplo, una consulta de Nueva York devuelve varias coincidencias correctas.
Ambiguous: la ubicación es uno de un conjunto de posibles coincidencias. Por ejemplo, al consultar la dirección postal 128 Main St., la respuesta puede devolver dos ubicaciones para 128 North Main St. y 128 South Main St. porque no hay suficiente información para determinar qué opción elegir.
UpHierarchy: la ubicación representa un movimiento hacia arriba de la jerarquía geográfica. Esto ocurre cuando no se encontró una coincidencia para la solicitud de ubicación, por lo que se devuelve un resultado menos preciso. Por ejemplo, si no se encuentra una coincidencia para la dirección solicitada, se puede devolver un código de coincidencia de UpHierarchy con un tipo de entidad RoadBlock.
| Valor | Description |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| Nombre | Tipo | Description |
|---|---|---|
| address |
Dirección del resultado |
|
| confidence |
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica. |
|
| geocodePoints |
Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido. |
|
| matchCodes |
Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta. Por ejemplo, una ubicación con codificación geográfica con códigos de coincidencia de Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Los valores posibles son:
|
|
| type |
string |
Uno de los valores siguientes:
|
ReverseGeocodingResultTypeEnum
Especifique los tipos de entidad que desee en la respuesta. Solo se devolverán los tipos que especifique. Si el punto no se puede asignar a los tipos de entidad especificados, no se devuelve información de ubicación en la respuesta. El valor predeterminado es todas las entidades posibles. Lista separada por comas de tipos de entidad seleccionados de las siguientes opciones.
- Dirección
- Vecindario
- PopulatedPlace
- Código postal1
- AdminDivision1
- AdminDivision2
- País/Región
Estos tipos de entidad se ordenan de la entidad más específica a la entidad menos específica. Cuando se encuentran entidades de más de un tipo de entidad, solo se devuelve la entidad más específica. Por ejemplo, si especifica Address y AdminDistrict1 como tipos de entidad y entidades se encontraron para ambos tipos, solo se devuelve la información de la entidad Address en la respuesta.
| Valor | Description |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
UsageTypeEnum
El mejor uso para el punto de código geográfico.
Cada punto de código geográfico se define como punto de Route, un punto de Display o ambos.
Use Route puntos si va a crear una ruta a la ubicación. Use Display puntos si muestra la ubicación en un mapa. Por ejemplo, si la ubicación es un parque, un punto de Route puede especificar una entrada al parque donde puede entrar con un coche y un punto de Display puede ser un punto que especifique el centro del parque.
| Valor | Description |
|---|---|
| Display | |
| Route |