Search - Get Reverse Geocoding
Use para obter um endereço e informações de localização a partir de coordenadas de longitude e latitude.
A API Get Reverse Geocoding
é uma solicitação de GET
HTTP usada para traduzir uma coordenada (exemplo: 37.786505, -122.3862) em um endereço de rua compreensível por humanos. Útil em aplicações de rastreamento onde 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 do URI
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica qual conta deve ser usada em conjunto com o modelo de segurança do Azure AD. Ele representa uma ID exclusiva para a conta do Azure Maps e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Maps. Para usar a segurança do Azure AD no Azure Maps, consulte os seguintes artigos para obter orientações. |
|
Accept-Language |
string |
Idioma em que os resultados da pesquisa devem ser retornados. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
Ocorreu um erro inesperado. Media Types: "application/geo+json" |
Segurança
AADToken
Estes são os Microsoft Entra OAuth 2.0 Flows. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 Maps.
Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.
Observação
- Essa definição de segurança requer o uso do cabeçalho
x-ms-client-id
para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps. - O
Authorization URL
é específico para a instância de nuvem pública do Azure. As 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 a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
- O uso do SDK da Web do Azure Maps 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
Fluxo:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Âmbitos
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Essa é uma chave compartilhada que é provisionada ao criar um de recursos do
Com essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.
Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do
Com esse token, qualquer aplicativo é autorizado a acessar com controles de acesso baseados em função do Azure e controle de grão fino para a expiração, taxa e região(ões) 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 segura 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 do
Tipo:
apiKey
Em:
header
Exemplos
Search point -122.138681, 47.630358
Pedido de amostra
GET https://atlas.microsoft.com/reverseGeocode?api-version=2025-01-01&coordinates=-122.138681,47.630358
Resposta da amostra
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
Name | Description |
---|---|
Address |
O endereço do resultado |
Admin |
O nome da subdivisão no país ou região de um endereço. Este 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 geocódigo. |
Confidence |
O nível de confiança de que o resultado da localização geocodificada é 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 uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada. |
Country |
|
Error |
O erro de gerenciamento de recursos informações adicionais. |
Error |
O detalhe do erro. |
Error |
Resposta de erro |
Feature |
O tipo de um objeto FeatureCollection deve ser FeatureCollection. |
Features |
|
Feature |
O tipo de recurso deve ser Recurso. |
Geocode |
Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido. |
Geocoding |
Este objeto é retornado de uma chamada de Geocoding bem-sucedida |
Geo |
Um tipo de geometria |
Intersection |
O endereço do resultado. |
Match |
Um ou mais valores de código de correspondência 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 que você deseja 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 localização será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas dos tipos de entidade selecionados entre as opções a seguir.
Estes tipos de entidades 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 encontradas para ambos os tipos, somente as informações da entidade Address serão retornadas na resposta. |
Usage |
O melhor uso para o ponto de geocódigo.
Cada ponto de geocódigo é definido como um ponto de |
Address
O endereço do resultado
Name | Tipo | Description |
---|---|---|
addressLine |
string |
AddressLine que inclui o nome e o número da rua |
adminDistricts |
O nome da subdivisão no país ou região de um endereço. Este 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 Endereço formatado |
intersection |
O endereço do resultado. |
|
locality |
string |
Propriedade de localidade |
neighborhood |
string |
propriedade do bairro |
postalCode |
string |
Propriedade do Código Postal |
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 de um endereço. Este 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.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome completo do estado, como Washington, Para adminDistrict[1], este poderia ser o nome completo do condado |
shortName |
string |
O nome curto para o campo adminDistrict correspondente, Para adminDistrict[0], este poderia ser o nome curto do estado, como WA, Para adminDistrict[1], este poderia ser o nome curto do condado |
CalculationMethodEnum
O método que foi usado para calcular o ponto de geocódigo.
Valor | Description |
---|---|
Interpolation |
O ponto de geocódigo foi combinado com um ponto em uma estrada usando interpolação. |
InterpolationOffset |
O ponto de geocódigo foi combinado com 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 combinado com o centro de uma parcela. |
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 da localização geocodificada é 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 uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada.
Valor | Description |
---|---|
High |
Se a confiança estiver definida como Se uma solicitação incluir um local ou uma exibição, a classificação pode mudar apropriadamente. 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 devolvida 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 geocodificação só pode corresponder a um código postal. Nesse caso, se o serviço de geocódigo tiver uma confiança de que o código postal 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 os locais (como a localização do usuário ou a importância relativa do local), 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
Name | Tipo | Description |
---|---|---|
ISO |
string |
ISO do país/região |
name |
string |
nome do país/região |
ErrorAdditionalInfo
O erro de gerenciamento de recursos informações adicionais.
Name | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorDetail
O detalhe do erro.
Name | Tipo | Description |
---|---|---|
additionalInfo |
O erro informações adicionais. |
|
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
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
FeatureCollectionEnum
O tipo de um objeto FeatureCollection deve ser FeatureCollection.
Valor | Description |
---|---|
FeatureCollection |
FeaturesItem
FeatureTypeEnum
O tipo de recurso deve ser Recurso.
Valor | Description |
---|---|
Feature |
GeocodePoints
Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido.
GeocodingResponse
Este objeto é retornado de uma chamada de Geocoding bem-sucedida
Name | Tipo | Description |
---|---|---|
features | ||
nextLink |
string |
O é o link para a próxima página dos recursos retornados. Se for a última página, não há este campo. |
type |
O tipo de um objeto FeatureCollection deve ser FeatureCollection. |
GeoJsonPoint
Um tipo de geometria GeoJSON Point
válido. Consulte RFC 7946 para obter detalhes.
Intersection
O endereço do resultado.
Name | Tipo | Description |
---|---|---|
baseStreet |
string |
Rua principal para o local. |
displayName |
string |
Nome completo do cruzamento. |
intersectionType |
string |
Tipo de intersecção. |
secondaryStreet1 |
string |
A primeira rua que se cruza. |
secondaryStreet2 |
string |
Se houver, a segunda rua que se cruza. |
MatchCodesEnum
Um ou mais valores de código de correspondência 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 geocódigo foi encontrado para as informações de localização e que o serviço de geocódigo não tinha 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 geocódigo que correspondesse a todas as informações de localização fornecidas, de modo que o serviço de geocódigo teve que pesquisar hierarquia superior e encontrar várias correspondências nesse nível. Um exemplo de Ambiguous
e UpHierarchy
resultado é quando você fornece informações completas de endereço, mas o serviço de geocodificação não consegue localizar uma correspondência para o endereço 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 partida ou todas as partidas retornadas são consideradas partidas fortes. Por exemplo, uma consulta para Nova York retorna várias correspondências Boas.
Ambiguous
: A localização faz parte de um conjunto de possíveis correspondências. Por exemplo, quando você consulta o endereço 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
: A localização representa um movimento para cima na 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 não for possível encontrar uma correspondência para o endereço solicitado, poderá ser devolvido um código de correspondência de UpHierarchy
com um tipo de entidade RoadBlock.
Valor | Description |
---|---|
Good | |
Ambiguous | |
UpHierarchy |
Properties
Name | Tipo | Description |
---|---|---|
address |
O endereço do resultado |
|
confidence |
O nível de confiança de que o resultado da localização geocodificada é 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 uma localização geocodificada baseia-se em muitos fatores, incluindo a importância relativa da localização geocodificada e a localização do utilizador, se especificada. |
|
geocodePoints |
Uma coleção de pontos de geocódigo que diferem em como eles foram calculados e seu uso sugerido. |
|
matchCodes |
Um ou mais valores de código de correspondência 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 dos seguintes:
|
ReverseGeocodingResultTypeEnum
Especifique os tipos de entidade que você deseja 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 localização será retornada na resposta. O valor padrão é todas as entidades possíveis. Uma lista separada por vírgulas dos tipos de entidade selecionados entre as opções a seguir.
- Endereço
- Bairro
- PopulatedPlace
- Código postal1
- AdminDivision1
- AdminDivision2
- País/Região
Estes tipos de entidades 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 encontradas 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 geocódigo.
Cada ponto de geocódigo é definido como um ponto de Route
, um ponto de Display
ou ambos.
Use Route
pontos se estiver criando uma rota para o local. Use Display
pontos se estiver mostrando a localização em um mapa. Por exemplo, se o local for um parque, um ponto de Route
pode especificar uma entrada para o parque onde você pode entrar com um carro, e um ponto de Display
pode ser um ponto que especifica o centro do parque.
Valor | Description |
---|---|
Display | |
Route |