Search - Get Reverse Geocoding
Use para obter um endereço e informações de localização das coordenadas de longitude e latitude.
A API Get Reverse Geocoding é uma solicitação HTTP GET usada para converter uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil no acompanhamento de aplicativos em que você recebe um feed gps do dispositivo ou ativo e deseja saber o endereço associado às coordenadas. Esse ponto de extremidade retornará informações de endereço para uma determinada coordenada.
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 URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Número de versão da API do Azure Mapas. |
|
coordinates
|
query | True |
number[] |
As coordenadas do local que você deseja reverter o geocódigo. Exemplo: &coordinates=lon,lat |
|
result
|
query |
Especifique os tipos de entidade desejados na resposta. Somente os tipos especificados serão retornados. Se o ponto não puder ser mapeado para os tipos de entidade especificados, nenhuma informação de local será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionada nas opções a seguir.
Esses tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando entidades de mais de um tipo de entidade são encontradas, somente a entidade mais específica é retornada. Por exemplo, se você especificar Address e AdminDistrict1 como tipos de entidade e entidades foram encontrados para ambos os tipos, somente as informações da entidade Address serão retornadas na resposta. |
||
|
view
|
query |
string |
Uma cadeia de caracteres que representa uma de código de região/país iso 3166-1 do ISO 3166-1 alfa-2. Isso alterará as bordas e rótulos contestados geopolíticos para se alinharem com a região de usuário especificada. Por padrão, o parâmetro View é definido como "Automático", mesmo que você não o tenha definido na solicitação. Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qual conta destina-se ao uso em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para obter mais informações sobre como usar a segurança de ID do Microsoft Entra no Azure Mapas, consulte Gerenciar autenticação no Azure Mapas. |
|
| Accept-Language |
string |
Idioma no qual os resultados da pesquisa devem ser retornados. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY Media Types: "application/geo+json" |
|
| Other Status Codes |
Ocorreu um erro inesperado. Media Types: "application/geo+json" |
Segurança
AADToken
Estas são as Fluxos de do Microsoft Entra OAuth 2.0. Quando emparelhado com acesso baseado em função do Azure controle, ele pode ser usado para controlar o acesso às APIs REST do Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais sub-recursos ou conta de recurso do Azure Mapas. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para APIs REST do Azure Mapas.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de controlar o acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-idpara indicar a qual recurso do Azure Mapas o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento do Mapas. - O
Authorization URLé específico para a instância de nuvem pública do Azure. Nuvens soberanas têm URLs de autorização exclusivas e configurações de ID do Microsoft Entra. - O controle de acesso baseado em função do Azure é configurado do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- O uso do SDK da Web do do Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Para obter mais informações sobre a plataforma de identidade da Microsoft, consulte visão geral da plataforma de identidade da Microsoft.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada provisionada ao criar um recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Em outras palavras, elas podem atualmente ser tratadas como chaves mestras para a conta para a qual são emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor a servidor de APIs REST do Azure Mapas, em que essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Esse é um token de assinatura de acesso compartilhado criado a partir da operação LISTA SAS no recurso do Azure Mapas por meio do plano de gerenciamento do Azure por meio do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado para expiração, taxa e região(s) de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de forma mais protegida do que a chave compartilhada.
Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no de recursos da conta de mapa de
Tipo:
apiKey
Em:
header
Exemplos
Search point -122.138681, 47.630358
Solicitação de exemplo
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
Resposta de exemplo
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
]
}
]
}
Definições
| Nome | Description |
|---|---|
| Address |
O endereço do resultado |
|
Admin |
O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região. |
|
Calculation |
O método que foi usado para calcular o ponto de código geográfico. |
|
Confidence |
O nível de confiança de que o resultado do local geocodificado é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência. A confiança de um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado. |
|
Country |
|
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Feature |
O tipo de objeto FeatureCollection deve ser FeatureCollection. |
|
Features |
|
|
Feature |
O tipo de um recurso deve ser Feature. |
|
Geocode |
Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu uso sugerido. |
|
Geocoding |
Esse objeto é retornado de uma chamada de geocodificação bem-sucedida |
|
Geo |
Um tipo de geometria de |
| Intersection |
O endereço do resultado. |
|
Match |
Um ou mais valores de código correspondentes que representam o nível de geocodificação para cada local na resposta. Por exemplo, um local geocodificado com códigos de correspondência de Da mesma forma, um local geocodificado com códigos de correspondência de Os valores possíveis são:
|
| Properties | |
|
Reverse |
Especifique os tipos de entidade desejados na resposta. Somente os tipos especificados serão retornados. Se o ponto não puder ser mapeado para os tipos de entidade especificados, nenhuma informação de local será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionada nas opções a seguir.
Esses tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando entidades de mais de um tipo de entidade são encontradas, somente a entidade mais específica é retornada. Por exemplo, se você especificar Address e AdminDistrict1 como tipos de entidade e entidades foram encontrados para ambos os tipos, somente as informações da entidade Address serão retornadas na resposta. |
|
Usage |
O melhor uso para o ponto de código geográfico.
Cada ponto de código geográfico é definido como um ponto de |
Address
O endereço do resultado
| Nome | Tipo | Description |
|---|---|---|
| addressLine |
string |
AddressLine que inclui Nome e Número da Rua |
| adminDistricts |
O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região. |
|
| countryRegion | ||
| formattedAddress |
string |
Propriedade Address formatada |
| intersection |
O endereço do resultado. |
|
| locality |
string |
propriedade localidade |
| neighborhood |
string |
propriedade neighborhood |
| postalCode |
string |
Propriedade Postal Code |
| streetName |
string |
O nome da rua de formattedAddress |
| streetNumber |
string |
O número na rua, se disponível, de formattedAddress |
AdminDistricts
O nome da subdivisão no país ou região para um endereço. Esse elemento normalmente é tratado como a subdivisão administrativa de primeira ordem, mas em alguns casos também contém a subdivisão de segunda, terceira ou quarta ordem em um país, dependência ou região.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome do campo adminDistrict correspondente, For adminDistrict[0], pode ser o nome completo do estado, como Washington, For adminDistrict[1], este pode ser o nome completo do condado |
| shortName |
string |
O nome curto do campo adminDistrict correspondente, For adminDistrict[0], pode ser um nome curto de estado, como WA, For adminDistrict[1], esse pode ser o nome curto do município |
CalculationMethodEnum
O método que foi usado para calcular o ponto de código geográfico.
| Valor | Description |
|---|---|
| Interpolation |
O ponto de geocódigo foi correspondido a um ponto em uma estrada usando interpolação. |
| InterpolationOffset |
O ponto de geocódigo foi correspondido a um ponto em uma estrada usando interpolação com um deslocamento adicional para deslocar o ponto para o lado da rua. |
| Parcel |
O ponto de geocódigo foi correspondido ao centro de um lote. |
| Rooftop |
O ponto de geocódigo foi combinado com o telhado de um edifício. |
ConfidenceEnum
O nível de confiança de que o resultado do local geocodificado é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência.
A confiança de um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado.
| Valor | Description |
|---|---|
| High |
Se a confiança estiver definida como Se uma solicitação incluir um local ou uma vista, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" retorna "Paris, França" e "Paris, TX" ambos com |
| Medium |
Em algumas situações, a correspondência retornada pode não estar no mesmo nível das informações fornecidas na solicitação. Por exemplo, uma solicitação pode especificar informações de endereço e o serviço de geocódigo pode corresponder apenas a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o CEP corresponde aos dados, a confiança será definida como Se as informações de localização na consulta forem ambíguas e não houver informações adicionais para classificar as localizações (como a localização do utilizador ou a importância relativa da localização), a confiança será definida como Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar um local específico, um valor de localização menos preciso poderá ser retornado e a confiança será definida como |
| Low |
CountryRegion
| Nome | Tipo | Description |
|---|---|---|
| ISO |
string |
ISO do país/região |
| name |
string |
nome do país/região |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
| Nome | Tipo | Description |
|---|---|---|
| info |
object |
As informações adicionais. |
| type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
FeatureCollectionEnum
O tipo de objeto FeatureCollection deve ser FeatureCollection.
| Valor | Description |
|---|---|
| FeatureCollection |
FeaturesItem
FeatureTypeEnum
O tipo de um recurso deve ser Feature.
| Valor | Description |
|---|---|
| Feature |
GeocodePoints
Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu uso sugerido.
GeocodingResponse
Esse objeto é retornado de uma chamada de geocodificação bem-sucedida
| Nome | Tipo | Description |
|---|---|---|
| features | ||
| nextLink |
string |
É o link para a próxima página dos recursos retornados. Se for a última página, não este campo. |
| type |
O tipo de objeto FeatureCollection deve ser FeatureCollection. |
GeoJsonPoint
Um tipo de geometria de GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.
Intersection
O endereço do resultado.
| Nome | Tipo | Description |
|---|---|---|
| baseStreet |
string |
Rua primária para o local. |
| displayName |
string |
Nome completo da interseção. |
| intersectionType |
string |
Tipo de interseção. |
| secondaryStreet1 |
string |
A primeira rua de interseção. |
| secondaryStreet2 |
string |
Se houver, a segunda rua de interseção. |
MatchCodesEnum
Um ou mais valores de código correspondentes que representam o nível de geocodificação para cada local na resposta.
Por exemplo, um local geocodificado com códigos de correspondência de Good e Ambiguous significa que mais de um local de código geográfico foi encontrado para as informações de localização e que o serviço de geocódigo não tinha uma hierarquia de pesquisa para encontrar uma correspondência.
Da mesma forma, um local geocodificado com códigos de correspondência de Ambiguous e UpHierarchy implica que não foi possível encontrar um local de código geográfico que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar a hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de um resultado Ambiguous e UpHierarchy é quando você fornece informações de endereço completas, mas o serviço de geocodificação não pode localizar uma correspondência para o endereço de rua e, em vez disso, retorna informações para mais de um valor roadblock.
Os valores possíveis são:
Good: o local tem apenas uma correspondência ou todas as correspondências retornadas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências boas.
Ambiguous: o local é uma de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço da rua 128 Main St., a resposta pode retornar dois locais para 128 North Main St. e 128 South Main St. porque não há informações suficientes para determinar qual opção escolher.
UpHierarchy: o local representa um movimento para cima da hierarquia geográfica. Isso ocorre quando uma correspondência para a solicitação de local não foi encontrada, portanto, um resultado menos preciso é retornado. Por exemplo, se uma correspondência para o endereço solicitado não puder ser encontrada, um código de correspondência de UpHierarchy com um tipo de entidade RoadBlock poderá ser retornado.
| Valor | Description |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| Nome | Tipo | Description |
|---|---|---|
| address |
O endereço do resultado |
|
| confidence |
O nível de confiança de que o resultado do local geocodificado é uma correspondência. Use esse valor com o código de correspondência para determinar informações mais completas sobre a correspondência. A confiança de um local geocodificado baseia-se em muitos fatores, incluindo a importância relativa do local geocodificado e a localização do usuário, se especificado. |
|
| geocodePoints |
Uma coleção de pontos de código geográfico que diferem em como eles foram calculados e seu uso sugerido. |
|
| matchCodes |
Um ou mais valores de código correspondentes que representam o nível de geocodificação para cada local na resposta. Por exemplo, um local geocodificado com códigos de correspondência de Da mesma forma, um local geocodificado com códigos de correspondência de Os valores possíveis são:
|
|
| type |
string |
Um destes:
|
ReverseGeocodingResultTypeEnum
Especifique os tipos de entidade desejados na resposta. Somente os tipos especificados serão retornados. Se o ponto não puder ser mapeado para os tipos de entidade especificados, nenhuma informação de local será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionada nas opções a seguir.
- Endereço
- Vizinhança
- PopulatedPlace
- Postcode1
- AdminDivision1
- AdminDivision2
- Região/País
Esses tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando entidades de mais de um tipo de entidade são encontradas, somente a entidade mais específica é retornada. Por exemplo, se você especificar Address e AdminDistrict1 como tipos de entidade e entidades foram encontrados para ambos os tipos, somente as informações da entidade Address serão retornadas na resposta.
| Valor | Description |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
UsageTypeEnum
O melhor uso para o ponto de código geográfico.
Cada ponto de código geográfico é definido como um ponto de Route, um ponto Display ou ambos.
Use Route pontos se estiver criando uma rota para o local. Use Display pontos se estiver mostrando o local em um mapa. Por exemplo, se o local for um parque, um ponto Route poderá especificar uma entrada para o parque em que você pode entrar com um carro e um ponto Display pode ser um ponto que especifica o centro do parque.
| Valor | Description |
|---|---|
| Display | |
| Route |