Compartilhar via


Search - Get Search Address Reverse

Use para obter um endereço de rua e informações de localização de coordenadas de latitude e longitude.
A Get Search Address Reverse API é e a solicitação HTTP GET que retorna um endereço de rua ou local quando determinadas coordenadas de latitude e longitude.

Pode haver momentos em que você precisa converter uma coordenada (exemplo: 37,786505, -122,3862) em um endereço de rua compreensível por humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço a coordenada está localizada. Esse ponto de extremidade retornará informações de endereço para 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 de URI

Nome Em Obrigatório Tipo Description
format
path True

ResponseFormat

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

api-version
query True

string

Número de versão da API de Mapas Azure.

query
query True

number[]

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

allowFreeformNewline
query

boolean

Formato de novas linhas no endereço formatado.

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

entityType
query

GeographicEntityType

Especifica o nível de filtragem executado em geografias. Restringe a pesquisa de tipos de entidade geography especificados, por exemplo, retornar somente município. A resposta resultante conterá a ID de geografia, bem como o tipo de entidade correspondente. Se você fornecer mais de uma entidade como uma lista separada por vírgulas, o ponto de extremidade retornará a "menor entidade disponível". A ID de Geometria retornada pode ser usada para obter a geometria dessa geografia por meio da API Obter Pesquisa Polígono. Os seguintes parâmetros são ignorados quando entityType é definido:

  • Indo
  • número
  • returnRoadUse
  • returnSpeedLimit
  • roadUse
  • returnMatchType
heading
query

integer

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

language
query

string

Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de idioma IETF com suporte, que não diferencia maiúsculas de minúsculas. Quando os dados no idioma especificado não estão disponíveis para um campo específico, o idioma padrão é usado.

Consulte Idiomas com suporte para obter detalhes.

number
query

string

Número de rua como uma cadeia de caracteres. Se um número for enviado junto com a solicitação, a resposta poderá 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

Booliano. Para habilitar o retorno da matriz de uso da estrada para geocódigos reversos no nível da rua

returnSpeedLimit
query

boolean

Booliano. Para habilitar o retorno do limite de velocidade postado

roadUse
query

RoadUseType[]

Para restringir os geocódigos reversos a um determinado tipo de uso de estrada. A matriz de uso de estrada para geocódigos reversos pode ser uma ou mais de LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet

view
query

LocalizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite que você mostre os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões, e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo fornecerá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e para 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 Microsoft Entra ID. Ele representa uma ID exclusiva para a conta Azure Mapas e pode ser recuperado da API de Conta do plano de gerenciamento do Azure Mapas. Para usar Microsoft Entra ID segurança no Azure Mapas consulte os artigos a seguir para obter diretrizes.

Respostas

Nome Tipo Description
200 OK

ReverseSearchAddressResult

OK

Other Status Codes

ErrorResponse

Erro inesperado.

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso a Azure Mapas APIs REST. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. 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 Azure Mapas APIs REST.

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 acessar o controle em APIs e escopos específicos.

Observação

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas .
  • 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 Microsoft Entra ID.
  • O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
  • O uso do SDK da Web 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 plataforma de identidade da Microsoft, consulte visão geral 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 quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado com base na operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou 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 a expiração, a taxa e as regiõ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 maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta de mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Searches addresses for coordinates 37.337,-121.89

Solicitação de exemplo

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

Resposta de exemplo

{
  "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

Nome Description
Address

O endereço do resultado

BoundingBoxCompassNotation

A caixa delimitadora do local.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

LocalizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.

MatchType

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

QueryType

O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.

ResponseFormat

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

ReverseSearchAddressResult

Esse objeto é retornado de uma chamada inversa de endereço de Pesquisa bem-sucedida

ReverseSearchAddressResultItem

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

RoadUseType

Descreve os possíveis usos de uma estrada.

SearchSummary

Objeto summary para uma resposta da API Pesquisa.

Address

O endereço do resultado

Nome Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora do local.

buildingNumber

string

O número do prédio na rua. PRETERIDO, use streetNumber em vez disso.

country

string

nome do país/região

countryCode

string

País (Observação: 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

Município

countrySubdivision

string

Estado ou Província

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 Escócia e ON para Ontário.

countrySubdivisionName

string

O nome completo de um primeiro nível de hierarquia administrativa de país/região. Esse campo aparece somente no caso de countrySubdivision ser apresentado em um formulário abreviado. Com suporte apenas para EUA, Canadá e Reino Unido.

countryTertiarySubdivision

string

Área Nomeada

crossStreet

string

O nome da rua que está sendo atravessada.

extendedPostalCode

string

Cep estendido (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, seu nome completo de 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. Esse campo é usado para compilar a freeformAddress propriedade . localName representa o município postal. Dependendo do local, localName é o nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido de uma cidade ou cidade, use localName em vez de municipality.

municipality

string

Cidade/Cidade
Observação: municipality representa o município residencial. Dependendo do local, o municipality valor pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou cidade, é sugerido que o localName valor seja usado 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 os habitantes.

postalCode

string

Cep/CEP

routeNumbers

string[]

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

street

string

O nome da rua. PRETERIDO, use streetName.

streetName

string

O nome da rua.

streetNameAndNumber

string

O nome e o número da rua.

streetNumber

string

O número do prédio na rua.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Nome Tipo Description
entity

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.

northEast

string

Latitude do Nordeste, coordenada de longitude da caixa delimitadora como floats separados por vírgulas

southWest

string

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

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocódigo reverso, isso é sempre igual à posição.

Nome Tipo Description
position

string

Posicionar entidade

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

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 de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

Nome Tipo Description
Country

string

nome do país/região

CountrySecondarySubdivision

string

Município

CountrySubdivision

string

Estado ou Província

CountryTertiarySubdivision

string

Área Nomeada

Municipality

string

Cidade/Cidade

MunicipalitySubdivision

string

Sub/Super Cidade

Neighbourhood

string

Bairro

PostalCodeArea

string

Cep/Cep

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

Nome Tipo Description
lat

number

Propriedade Latitude

lon

number

Propriedade Longitude

LocalizedMapView

O parâmetro View (também chamado de parâmetro "região do usuário") permite mostrar os mapas corretos para um determinado país/região para regiões geopolíticas disputadas. Diferentes países/regiões têm diferentes exibições dessas regiões e o parâmetro View permite que seu aplicativo cumpra a exibição exigida pelo país/região que seu aplicativo atenderá. Por padrão, o parâmetro View é definido como "Unificado", mesmo que você não o tenha definido na solicitação. É sua responsabilidade determinar a localização de seus usuários e, em seguida, definir o parâmetro View corretamente para esse local. Como alternativa, você tem a opção de definir 'View=Auto', que retornará os dados do mapa com base no endereço IP da solicitação. O parâmetro View em Azure Mapas deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relativas ao mapeamento, do país/região em que são disponibilizados mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio de Azure Mapas. Exemplo: view=IN.

Consulte Modos de exibição com suporte para obter detalhes e para ver as Exibições disponíveis.

Nome Tipo Description
AE

string

Emirados Árabes Unidos (Exibição Árabe)

AR

string

Argentina (Exibição Argentina)

Auto

string

Retornar os dados do mapa com base no endereço IP da solicitação.

BH

string

Bahrein (Exibição Árabe)

IN

string

Índia (Exibição Indiana)

IQ

string

Iraque (Exibição Árabe)

JO

string

Jordânia (Exibição Árabe)

KW

string

Kuwait (Exibição Árabe)

LB

string

Líbano (Exibição Árabe)

MA

string

Marrocos (Exibição Marroquina)

OM

string

Omã (Exibição Árabe)

PK

string

Paquistão (Exibição Paquistanesa)

PS

string

Autoridade Palestina (Exibição Árabe)

QA

string

Qatar (Exibição Árabe)

SA

string

Arábia Saudita (Exibição Árabe)

SY

string

Síria (Exibição Árabe)

Unified

string

Exibição Unificada (Outras)

YE

string

Iêmen (Exibição Árabe)

MatchType

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

Nome Tipo Description
AddressPoint

string

HouseNumberRange

string

Street

string

QueryType

O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.

Nome Tipo Description
NEARBY

string

Pesquisa foi executado em torno de uma certa latitude e longitude com um raio definido

NON_NEAR

string

Pesquisa foi executado globalmente, sem preconceitos para uma certa latitude e longitude, e nenhum raio definido

ResponseFormat

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

Nome Tipo Description
json

string

O formato de intercâmbio de dados de notação de objeto JavaScript

xml

string

A linguagem de marcação extensível

ReverseSearchAddressResult

Esse objeto é retornado de uma chamada inversa de endereço de Pesquisa bem-sucedida

Nome Tipo Description
addresses

ReverseSearchAddressResultItem[]

Matriz de endereços

summary

SearchSummary

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

ReverseSearchAddressResultItem

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

Nome Tipo Description
address

Address

O endereço do resultado

matchType

MatchType

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

Um destes:

  • AddressPoint
  • HouseNumberRange
  • Street
position

string

Propriedade Position na forma de "{latitude},{longitude}"

roadUse

RoadUseType[]

Descreve os possíveis usos de uma estrada.

RoadUseType

Descreve os possíveis usos de uma estrada.

Nome Tipo Description
Arterial

string

LimitedAccess

string

LocalStreet

string

Ramp

string

Rotary

string

Terminal

string

SearchSummary

Objeto summary para uma resposta da API Pesquisa.

Nome Tipo Description
fuzzyLevel

integer

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

geoBias

LatLongPairAbbreviated

Indicação de quando o mecanismo de pesquisa interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado definindo os parâmetros lat e lon quando disponíveis. Em outros casos, é puramente interno.

limit

integer

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

numResults

integer

Número de resultados na resposta.

offset

integer

O deslocamento inicial dos Resultados retornados dentro do conjunto de resultados completo.

query

string

O parâmetro de consulta que foi usado para produzir esses resultados de pesquisa.

queryTime

integer

Tempo gasto resolvendo a consulta, em milissegundos.

queryType

QueryType

O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.

totalResults

integer

O número total de Resultados encontrados.