Search - Get Search Address Reverse

Utilize para obter um endereço de rua e informações de localização a partir de coordenadas de latitude e longitude.
A Get Search Address Reverse API é e o pedido HTTP GET que devolve um endereço de rua ou localização quando são dadas coordenadas de latitude e longitude.

Pode haver alturas em que precisa de traduzir uma coordenada (por exemplo: 37.786505, -122.3862) para um endereço de rua compreensível para humanos. Na maioria das vezes, isto é necessário no controlo de aplicações onde recebe um feed GPS do dispositivo ou recurso e quer saber qual é o endereço onde a coordenada está localizada. Este ponto final devolverá as informações de endereço de uma determinada coordenada.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

Parâmetros do URI

Name Em Necessário Tipo Description
format
path True

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.

api-version
query True

string

Número da versão da API Azure Maps.

query
query True

number[]

A consulta aplicável especificada como uma cadeia separada por vírgulas composta por latitude seguida de longitude, por exemplo, "47.641268,-122.125679".

allowFreeformNewline
query

boolean

Formato de novas linhas no endereço formatado.

Se for verdadeiro, o endereço conterá novas linhas. Se for falso, as novas linhas serão convertidas em vírgulas.

entityType
query

GeographicEntityType

Especifica o nível de filtragem realizado em geografias. Restringe a pesquisa de tipos de entidades geográficas especificadas, por exemplo, devolver apenas o município. A resposta resultante irá conter o ID de geografia, bem como o tipo de entidade correspondente. Se fornecer mais do que uma entidade como uma lista separada por vírgulas, o ponto final devolverá a "entidade mais pequena disponível". O ID de Geometria devolvido pode ser utilizado para obter a geometria dessa geografia através da API Get Pesquisa Polygon. Os parâmetros seguintes são ignorados quando entityType está definido:

  • cabeçalho
  • número
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
heading
query

integer

O cabeçalho direcional do veículo em graus, para viajar ao longo de um segmento de estrada. 0 é Norte, 90 é Leste e assim sucessivamente, os valores variam entre -360 e 360. A precisão pode incluir até uma casa decimal

language
query

string

Idioma no qual os resultados da pesquisa devem ser devolvidos. Deve ser uma das etiquetas de linguagem IETF suportadas, não sensível a maiúsculas e minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, é utilizado o idioma predefinido.

Consulte idiomas suportados para obter detalhes.

number
query

string

Número de rua como uma cadeia. Se um número for enviado juntamente com o pedido, a resposta pode incluir o lado da rua (Esquerda/Direita) e também uma posição de deslocamento para esse número

radius
query

integer

O raio em metros para para que os resultados sejam restritos à área definida

returnMatchType
query

boolean

Inclua informações sobre o tipo de correspondência do geocódigo obtido na resposta.

returnRoadUse
query

boolean

Booleano. Para ativar o retorno da matriz de utilização da estrada para geocódigos inversos ao nível da rua

returnSpeedLimit
query

boolean

Booleano. Para ativar a devolução do limite de velocidade publicado

roadUse
query

RoadUseType[]

Para restringir os geocódigos inversos a um determinado tipo de utilização rodoviária. A matriz de utilização de estradas para geocódigos inversos pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

view
query

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

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 Microsoft Entra ID. Representa um ID exclusivo para a conta Azure Maps e pode ser obtido a partir da API de Conta do plano de gestão Azure Maps. Para utilizar Microsoft Entra ID segurança no Azure Maps consulte os seguintes artigos para obter orientações.

Respostas

Name Tipo Description
200 OK

ReverseSearchAddressResult

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

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 Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. 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 Azure Maps APIs REST.

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 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 de 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 de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • A utilização do SDK Web 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 plataforma de identidades da Microsoft, consulte plataforma de identidades da Microsoft descrição geral.

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 quando Cria uma conta Azure Maps no portal do Azure ou com o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com esta chave, qualquer aplicação pode aceder a toda a API REST. Por outras palavras, esta chave pode ser utilizada como uma chave mestra na conta na qual são emitidas.

Para aplicações expostas publicamente, a nossa recomendação é utilizar a abordagem de aplicações cliente confidenciais para aceder Azure Maps APIs REST para que a sua chave possa ser armazenada de forma segura.

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso partilhado criado a partir da operação Listar SAS no recurso Azure Maps através do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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

Searches addresses for coordinates 37.337,-121.89

Pedido de amostra

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Resposta da amostra

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Definições

Name Description
Address

O endereço do resultado

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta a erros

GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço inverso.

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.

ReverseSearchAddressResult

Este objeto é devolvido a partir de uma chamada inversa de endereço Pesquisa bem-sucedida

ReverseSearchAddressResultItem

Objeto de resultado para uma resposta inversa de endereço Pesquisa

RoadUseType

Descreve as possíveis utilizações de uma estrada.

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa.

Address

O endereço do resultado

Name Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora da localização.

buildingNumber

string

O número do edifício na rua. PRETERIDO, utilize streetNumber em vez disso.

country

string

nome do país/região

countryCode

string

País (Nota: este é um código de duas letras, não um nome de país/região.)

countryCodeISO3

string

Código de país iso alfa-3

countrySecondarySubdivision

string

Concelho

countrySubdivision

string

Distrito

countrySubdivisionCode

string

countrySubdivisionCode prefixado por countryCode ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para Texas, SCT para a Escócia e ON para Ontário.

countrySubdivisionName

string

O nome completo de um primeiro nível da hierarquia administrativa do país/região. Este campo só é apresentado no caso de countrySubdivision ser apresentado num formulário abreviado. Apenas suportado para os EUA, Canadá e Reino Unido.

countryTertiarySubdivision

string

Área Nomeada

crossStreet

string

O nome da rua a ser atravessada.

extendedPostalCode

string

Código postal alargado (a disponibilidade depende da região).

freeformAddress

string

Uma linha de endereço formatada de acordo com as regras de formatação do país/região de origem de um Resultado ou, no caso de um país/região, o nome completo do país/região.

localName

string

Um componente de endereço que representa o nome de uma área geográfica ou localidade que agrupa vários objetos endereçáveis para fins de endereçamento, sem ser uma unidade administrativa. Este campo é utilizado para criar a freeformAddress propriedade. localName representa o município postal. Consoante a localização, localName é o nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido de uma cidade ou cidade, utilize localName em vez de municipality.

municipality

string

Cidade/Cidade
Nota: municipality representa o município residencial. Consoante a localização, o municipality valor pode diferir do nome mais conhecido de uma cidade ou cidade. Para o nome mais conhecido da cidade ou cidade, sugere-se que o localName valor seja utilizado em vez do municipality valor.

municipalitySubdivision

string

Sub/Super Cidade

neighbourhood

string

Um Bairro é uma área geograficamente localizada dentro de uma cidade ou cidade com características distintas e interações sociais entre habitantes.

postalCode

string

Código Postal/Código Postal

routeNumbers

string[]

Os códigos utilizados para identificar de forma inequívoca a rua

street

string

O nome da rua. Preterido, utilize streetName em vez disso.

streetName

string

O nome da rua.

streetNameAndNumber

string

O nome e o número da rua.

streetNumber

string

O número do edifício na rua.

BoundingBoxCompassNotation

A caixa delimitadora da localização.

Name Tipo Description
entity

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.

northEast

string

Latitude nordeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas

southWest

string

Latitude sudoeste, coordenada de longitude da caixa delimitadora como flutuantes separados por vírgulas

Entity

Origem do tipo de entidade da caixa delimitadora. Para a geocodificação inversa, esta opção é sempre igual à posição.

Name Tipo Description
position

string

Entidade de posiçã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ções adicionais.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Tipo de entidade geografia. Presente apenas quando entityType foi pedido e está disponível.

Name Tipo Description
Country

string

nome do país/região

CountrySecondarySubdivision

string

Concelho

CountrySubdivision

string

Distrito

CountryTertiarySubdivision

string

Área Nomeada

Municipality

string

Cidade/Cidade

MunicipalitySubdivision

string

Sub/Super Cidade

Neighbourhood

string

Bairro

PostalCodeArea

string

Código Postal/Código Postal

LatLongPairAbbreviated

Uma localização representada como latitude e longitude com nomes curtos "lat" & "lon".

Name Tipo Description
lat

number

Propriedade Latitude

lon

number

Propriedade Longitude

LocalizedMapView

O parâmetro Ver (também denominado parâmetro "região do utilizador") permite-lhe mostrar os mapas corretos para um determinado país/região para regiões geopolíticos disputadas. Diferentes países/regiões têm vistas diferentes dessas regiões e o parâmetro Ver permite que a sua aplicação cumpra a vista exigida pelo país/região que a sua aplicação irá servir. Por predefinição, o parâmetro Ver está definido como "Unificado", mesmo que não o tenha definido no pedido. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro Ver corretamente para essa localização. Em alternativa, tem a opção de definir "View=Auto", que devolverá os dados do mapa com base no endereço IP do pedido. O parâmetro Ver no Azure Maps tem de ser utilizado em conformidade com as leis aplicáveis, incluindo as relativas ao mapeamento, do país/região onde são disponibilizados mapas, imagens e outros dados e conteúdos de terceiros aos quais está autorizado a aceder através de Azure Maps. Exemplo: view=IN.

Consulte Vistas Suportadas para obter detalhes e para ver as Vistas disponíveis.

Name Tipo Description
AE

string

Emirados Árabes Unidos (Vista Árabe)

AR

string

Argentina (Vista Argentina)

Auto

string

Devolva os dados do mapa com base no endereço IP do pedido.

BH

string

Bahrein (Vista Árabe)

IN

string

Índia (Vista Indiana)

IQ

string

Iraque (Vista Árabe)

JO

string

Jordânia (Vista Árabe)

KW

string

Kuwait (Vista Árabe)

LB

string

Líbano (Vista Árabe)

MA

string

Marrocos (Vista Marroquina)

OM

string

Omã (Vista Árabe)

PK

string

Paquistão (Vista Paquistanesa)

PS

string

Autoridade Palestiniana (Vista Árabe)

QA

string

Qatar (Vista Árabe)

SA

string

Arábia Saudita (Vista Árabe)

SY

string

Síria (Vista Árabe)

Unified

string

Vista Unificada (Outros)

YE

string

Iémen (Vista Árabe)

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço inverso.

Name Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

Name Tipo Description
NEARBY

string

Pesquisa foi realizada em torno de uma determinada latitude e longitude com um raio definido

NON_NEAR

string

Pesquisa foi realizada globalmente, sem distorção para uma determinada latitude e longitude, e nenhum raio definido

ResponseFormat

Formato pretendido da resposta. O valor pode ser json ou xml.

Name Tipo Description
json

string

O Formato de Intercâmbio de Dados de Notação de Objetos JavaScript

xml

string

O Idioma de Marcação Extensível

ReverseSearchAddressResult

Este objeto é devolvido a partir de uma chamada inversa de endereço Pesquisa bem-sucedida

Name Tipo Description
addresses

ReverseSearchAddressResultItem[]

Matriz de endereços

summary

SearchSummary

Objeto de resumo para uma resposta inversa de endereço Pesquisa

ReverseSearchAddressResultItem

Objeto de resultado para uma resposta inversa de endereço Pesquisa

Name Tipo Description
address

Address

O endereço do resultado

matchType

MatchType

Informações sobre o tipo de correspondência.

Um dos seguintes:

  • AddressPoint
  • HouseNumberRange
  • Rua
position

string

Propriedade posição na forma de "{latitude},{longitude}"

roadUse

RoadUseType[]

Descreve as possíveis utilizações de uma estrada.

RoadUseType

Descreve as possíveis utilizações de uma estrada.

Name Tipo Description
Arterial

string

LimitedAccess

string

LocalStreet

string

Ramp

string

Rotary

string

Terminal

string

SearchSummary

Objeto de resumo para uma resposta da API Pesquisa.

Name Tipo Description
fuzzyLevel

integer

O nível máximo difuso necessário para fornecer Resultados.

geoBias

LatLongPairAbbreviated

Indicação quando o motor de busca interno aplicou um desvio geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isto pode ser afetado ao definir os parâmetros lat e lon sempre que disponíveis. Noutros casos, é puramente interno.

limit

integer

Número máximo de respostas que serão devolvidas

numResults

integer

Número de resultados na resposta.

offset

integer

O desvio inicial dos Resultados devolvidos no conjunto de Resultados completo.

query

string

O parâmetro de consulta que foi utilizado para produzir estes resultados de pesquisa.

queryTime

integer

Tempo gasto a resolver a consulta, em milissegundos.

queryType

QueryType

O tipo de consulta que está a ser devolvida: NEARBY ou NON_NEAR.

totalResults

integer

O número total de Resultados encontrados.