Search - Get Reverse Geocoding
Utilize para obter um endereço de rua e informações de localização a partir de coordenadas de longitude e latitude.
A Get Reverse Geocoding
API é um pedido HTTP GET
utilizado para traduzir uma coordenada (exemplo: 37.786505, -122.3862) para um endereço de rua compreensível para humanos. Útil no controlo de aplicações em que recebe um feed GPS do dispositivo ou recurso e quer saber o endereço associado às coordenadas. Este ponto final devolverá as informações de endereço de uma determinada coordenada.
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}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Número da versão da API do Azure Maps. |
coordinates
|
query | True |
number[] |
As coordenadas da localização em que pretende reverter o geocódigo. Exemplo: &coordenadas=lon,lat |
result
|
query |
Especifique os tipos de entidade que pretende na resposta. Só serão devolvidos os tipos que especificar. Se o ponto não puder ser mapeado para os tipos de entidade que especificar, não serão devolvidas informações de localização na resposta. O valor predefinido é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionados a partir das seguintes opções.
Estes tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando são encontradas entidades de mais do que um tipo de entidade, só é devolvida a entidade mais específica. Por exemplo, se especificar Endereço e AdminDistrict1 como entidades e tipos de entidade foram encontrados para ambos os tipos, apenas as informações da entidade Endereço são devolvidas na resposta. |
||
view
|
query |
string |
Uma cadeia que representa um código de região/país ISO 3166-1 Alpha-2. Isto irá alterar os limites e etiquetas geopolíticos contestados para se alinharem com a região de utilizador especificada. Por predefinição, o parâmetro Ver está definido como "Automático", mesmo que não o tenha definido no pedido. Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis. |
Cabeçalho do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-id |
string |
Especifica a conta que se destina à utilização em conjunto com o modelo de segurança do Azure AD. Representa um ID exclusivo para a conta do Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão do Azure Maps. Para utilizar a segurança do Azure AD no Azure Maps, veja os seguintes artigos para obter orientações. |
|
Accept-Language |
string |
Idioma no qual os resultados da pesquisa devem ser devolvidos. Consulte idiomas suportados para obter detalhes. |
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 Fluxos Microsoft Entra OAuth 2.0 . Quando emparelhado com o controlo de acesso baseado em funções do Azure , pode ser utilizado para controlar o acesso às APIs REST do Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais contas de recursos ou sub-recursos do Azure Maps. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para as APIs REST do Azure Maps.
Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.
Nota
- Esta definição de segurança requer a utilização do
x-ms-client-id
cabeçalho para indicar a que recurso do Azure Maps a aplicação está a pedir acesso. Isto pode ser adquirido a partir da API de gestão do Maps. - O
Authorization URL
é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Microsoft Entra ID. - O controlo de acesso baseado em funções do Azure é configurado a partir do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
- A utilização do SDK Web do Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.
- Para obter mais informações sobre a plataforma de identidades da Microsoft, consulte Descrição geral da plataforma de identidades 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
Esta é uma chave partilhada que é aprovisionada ao criar um recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com esta chave, qualquer aplicação está autorizada a aceder a todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras da conta para a qual são emitidas.
Para aplicações expostas publicamente, a nossa recomendação é utilizar o acesso servidor a servidor das APIs REST do Azure Maps, onde esta chave pode ser armazenada de forma segura.
Tipo:
apiKey
Em:
header
SAS Token
Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso do Azure Maps através do plano de gestão do Azure através do portal do Azure, do PowerShell, da CLI, dos SDKs do Azure ou das APIs REST.
Com este token, qualquer aplicação está autorizada a aceder com controlos de acesso baseados em funções do Azure e controlo detalhado para a expiração, taxa e regiões de utilização para o token específico. Por outras palavras, o Token de SAS pode ser utilizado para permitir que as aplicações controlem o acesso de uma forma mais segura do que a chave partilhada.
Para aplicações expostas publicamente, a nossa recomendação é configurar uma lista específica de origens permitidas no recurso da conta de Mapa para limitar o abuso de composição e renovar regularmente o Token de SAS.
Tipo:
apiKey
Em:
header
Exemplos
Search point -122.138681, 47.630358
Pedido de amostra
GET https://atlas.microsoft.com/reverseGeocode?api-version=2023-06-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": [
{
"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
]
}
]
}
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. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num país, dependência ou região. |
Calculation |
O método que foi utilizado para calcular o ponto de geocódigo. |
Confidence |
O nível de confiança de que o resultado da localização geocódigo corresponde. Utilize este valor com o código de correspondência para determinar para obter 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 especificado. |
Country |
|
Error |
Informações adicionais sobre o erro de gestão de recursos. |
Error |
O detalhe do erro. |
Error |
Resposta a erros |
Feature |
O tipo de objeto FeatureCollection tem de ser FeatureCollection. |
Features |
|
Feature |
O tipo de uma funcionalidade tem de ser Funcionalidade. |
Geocode |
Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida. |
Geocoding |
Este objeto é devolvido a partir de uma chamada de Geocodificação bem-sucedida |
Geo |
Um tipo de geometria válido |
Intersection |
O endereço do resultado. |
Match |
Um ou mais correspondem aos valores de código que representam o nível de geocodificação para cada localização na resposta. Por exemplo, uma localização geocódigo com códigos de correspondência e Da mesma forma, uma localização geocodificada com códigos de correspondência de Os valores possíveis são:
|
Properties | |
Reverse |
Especifique os tipos de entidade que pretende na resposta. Apenas os tipos que especificar serão devolvidos. Se o ponto não puder ser mapeado para os tipos de entidade que especificar, não serão devolvidas informações de localização na resposta. O valor predefinido é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionados nas seguintes opções.
Estes tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando são encontradas entidades de mais do que um tipo de entidade, só é devolvida a entidade mais específica. Por exemplo, se especificar Endereço e AdminDistrict1 como tipos de entidade e entidades foram encontrados para ambos os tipos, apenas as informações da entidade Endereço são devolvidas na resposta. |
Usage |
A melhor utilização para o ponto de geocódigo.
Cada ponto de geocódigo é definido como um |
Address
O endereço do resultado
Name | Tipo | Description |
---|---|---|
addressLine |
string |
AddressLine que inclui Nome da Rua e Número |
adminDistricts |
O nome da subdivisão no país ou região de um endereço. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num 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 de bairro |
postalCode |
string |
Propriedade Código Postal |
AdminDistricts
O nome da subdivisão no país ou região de um endereço. Normalmente, este elemento é tratado como a subdivisão administrativa da primeira ordem, mas em alguns casos também contém a subdivisão da segunda, terceira ou quarta ordem num país, dependência ou região.
Name | Tipo | Description |
---|---|---|
name |
string |
O nome do campo adminDistrict correspondente, Para adminDistrict[0], pode ser o nome completo do estado, como Washington, Para adminDistrict[1], este pode ser o nome completo do condado |
shortName |
string |
O nome abreviado do campo adminDistrict correspondente, Para adminDistrict[0], este pode ser um nome abreviado de estado, como WA, Para adminDistrict[1], este pode ser o nome abreviado do concelho |
CalculationMethodEnum
O método que foi utilizado para calcular o ponto de geocódigo.
Name | Tipo | Description |
---|---|---|
Interpolation |
string |
O ponto de geocódigo foi correspondido a um ponto numa estrada através da interpolação. |
InterpolationOffset |
string |
O ponto geocódigo foi correspondido a um ponto numa estrada usando interpolação com um desvio adicional para deslocar o ponto para o lado da rua. |
Parcel |
string |
O ponto geocódigo foi correspondido ao centro de uma parcela. |
Rooftop |
string |
O ponto geocódigo foi correspondido ao telhado de um edifício. |
ConfidenceEnum
O nível de confiança de que o resultado da localização geocódigo corresponde. Utilize este valor com o código de correspondência para determinar para obter 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 especificado.
Name | Tipo | Description |
---|---|---|
High |
string |
Se a confiança estiver definida como Se um pedido incluir uma localização ou uma vista, a classificação poderá ser alterada adequadamente. Por exemplo, uma consulta de localização para "Paris" devolve "Paris, França" e "Paris, TX" ambos com |
Low |
string |
|
Medium |
string |
Em algumas situações, a correspondência devolvida pode não estar ao mesmo nível das informações fornecidas no pedido. Por exemplo, um pedido pode especificar informações de endereço e o serviço de geocódigo só pode corresponder a um código postal. Neste caso, se o serviço de geocódigo tiver a confiança de que o código postal corresponde aos dados, a confiança está definida como Se as informações de localização na consulta forem ambíguas e não existirem 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 está definida como Se as informações de localização na consulta não fornecerem informações suficientes para geocodificar uma localização específica, poderá ser devolvido um valor de localização menos preciso e a confiança está definida como |
CountryRegion
Name | Tipo | Description |
---|---|---|
ISO |
string |
ISO do país/região |
name |
string |
nome do país/região |
ErrorAdditionalInfo
Informações adicionais sobre o erro de gestão de recursos.
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 |
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 a erros
Name | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
FeatureCollectionEnum
O tipo de objeto FeatureCollection tem de ser FeatureCollection.
Name | Tipo | Description |
---|---|---|
FeatureCollection |
string |
FeaturesItem
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada - EPSG:3857. Consulte RFC 7946 para obter detalhes. |
geometry |
Um tipo de geometria válido |
|
id |
string |
ID da funcionalidade devolvida |
properties | ||
type |
O tipo de uma funcionalidade tem de ser Funcionalidade. |
FeatureTypeEnum
O tipo de uma funcionalidade tem de ser Funcionalidade.
Name | Tipo | Description |
---|---|---|
Feature |
string |
GeocodePoints
Uma coleção de pontos geocódigo que diferem na forma como foram calculados e na respetiva utilização sugerida.
Name | Tipo | Description |
---|---|---|
calculationMethod |
O método que foi utilizado para calcular o ponto de geocódigo. |
|
geometry |
Um tipo de geometria válido |
|
usageTypes |
A melhor utilização para o ponto de geocódigo.
Cada ponto de geocódigo é definido como um |
GeocodingResponse
Este objeto é devolvido a partir de uma chamada de Geocodificação bem-sucedida
Name | Tipo | Description |
---|---|---|
features | ||
nextLink |
string |
É a ligação para a página seguinte das funcionalidades devolvidas. Se for a última página, não este campo. |
type |
O tipo de objeto FeatureCollection tem de ser FeatureCollection. |
GeoJsonPoint
Um tipo de geometria válido GeoJSON Point
. Consulte RFC 7946 para obter detalhes.
Name | Tipo | Description |
---|---|---|
bbox |
number[] |
Caixa delimitadora. Projeção utilizada - EPSG:3857. Consulte RFC 7946 para obter detalhes. |
coordinates |
number[] |
A |
type |
string:
Point |
Especifica o |
Intersection
O endereço do resultado.
Name | Tipo | Description |
---|---|---|
baseStreet |
string |
Rua principal para a localização. |
displayName |
string |
Nome completo da interseção. |
intersectionType |
string |
Tipo de interseção. |
secondaryStreet1 |
string |
A primeira rua interseccionada. |
secondaryStreet2 |
string |
Se houver, a segunda rua interseccionada. |
MatchCodesEnum
Um ou mais correspondem aos valores de código que representam o nível de geocodificação para cada localização na resposta.
Por exemplo, uma localização geocódigo com códigos de correspondência e Good
Ambiguous
significa que foi encontrada mais do que uma localização de geocódigo para as informações de localização e que o serviço de geocódigo não tinha a hierarquia de pesquisa para encontrar uma correspondência.
Da mesma forma, uma localização geocodificada com códigos de correspondência de Ambiguous
e UpHierarchy
implica que não foi possível encontrar uma localização de geocódigo que correspondesse a todas as informações de localização fornecidas, pelo que o serviço de geocódigo teve de procurar na hierarquia superior e encontrou várias correspondências nesse nível. Um exemplo de aumento de um Ambiguous
UpHierarchy
resultado é quando fornece informações de endereço completas, mas o serviço de geocódigo não consegue localizar uma correspondência para o endereço de rua e, em vez disso, devolve informações para mais do que um valor RoadBlock.
Os valores possíveis são:
Good
: a localização tem apenas uma correspondência ou todas as correspondências devolvidas são consideradas correspondências fortes. Por exemplo, uma consulta para Nova Iorque devolve várias Correspondências boas.
Ambiguous
: a localização é uma de um conjunto de correspondências possíveis. Por exemplo, quando consulta o endereço 128 Main St., a resposta pode devolver duas localizações para 128 North Main St. e 128 South Main St. porque não existem informações suficientes para determinar que opção escolher.
UpHierarchy
: a localização representa uma mudança para cima na hierarquia geográfica. Isto ocorre quando não foi encontrada uma correspondência para o pedido de localização, pelo que é devolvido um resultado menos preciso. Por exemplo, se não for possível encontrar uma correspondência para o endereço pedido, poderá ser devolvido um código de correspondência de com um tipo de UpHierarchy
entidade RoadBlock.
Name | Tipo | Description |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
Name | Tipo | Description |
---|---|---|
address |
O endereço do resultado |
|
confidence |
O nível de confiança de que o resultado da localização geocódigo corresponde. Utilize este valor com o código de correspondência para determinar para obter 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 especificado. |
|
geocodePoints |
Uma coleção de pontos geocódigos que diferem na forma como foram calculados e na utilização sugerida. |
|
matchCodes |
Um ou mais correspondem aos valores de código que representam o nível de geocodificação para cada localização na resposta. Por exemplo, uma localização geocódigo com códigos de correspondência e Da mesma forma, uma localização geocodificada 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 pretende na resposta. Apenas os tipos que especificar serão devolvidos. Se o ponto não puder ser mapeado para os tipos de entidade que especificar, não serão devolvidas informações de localização na resposta. O valor predefinido é todas as entidades possíveis. Uma lista separada por vírgulas de tipos de entidade selecionados nas seguintes opções.
- Endereço
- Bairro
- Lugar Preenchido
- Código postal1
- AdminDivision1
- AdminDivision2
- RegiãoDoPaís
Estes tipos de entidade são ordenados da entidade mais específica para a entidade menos específica. Quando são encontradas entidades de mais do que um tipo de entidade, só é devolvida a entidade mais específica. Por exemplo, se especificar Endereço e AdminDistrict1 como tipos de entidade e entidades foram encontrados para ambos os tipos, apenas as informações da entidade Endereço são devolvidas na resposta.
Name | Tipo | Description |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
UsageTypeEnum
A melhor utilização para o ponto de geocódigo.
Cada ponto de geocódigo é definido como um Route
ponto, um Display
ponto ou ambos.
Utilize Route
pontos se estiver a criar uma rota para a localização. Utilize Display
pontos se estiver a mostrar a localização num mapa. Por exemplo, se a localização for um parque, um Route
ponto pode especificar uma entrada para o parque onde pode entrar com um carro, e um Display
ponto pode ser um ponto que especifica o centro do parque.
Name | Tipo | Description |
---|---|---|
Display |
string |
|
Route |
string |