Search - Get Search Address Reverse

Referência

Serviço:: Maps

Versão da API:: 1.0

Use para obter um endereço de rua e informações de localização de coordenadas de latitude e longitude.
A API Get Search Address Reverse é e http GET solicitação 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 para humanos. Na maioria das vezes, isso é necessário no acompanhamento de aplicativos em que você recebe um feed GPS do dispositivo ou do 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}

Com parâmetros opcionais:

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 do Azure Mapas.
query	query	True	number[]	A consulta aplicável especificada como uma cadeia de caracteres separada por vírgula 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 Polígono de Pesquisa. Os seguintes parâmetros são ignorados quando entityType é definido: título número returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer minimum: -360 maximum: 360	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é um local decimal
language	query		string	Idioma no qual os resultados da pesquisa devem ser retornados. Deve ser uma das marcas de linguagem 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 de 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 que os resultados sejam restritos à área definida
returnMatchType	query		boolean	Inclua informações sobre o tipo de correspondência do geocodificador obtido na resposta.
returnRoadUse	query		boolean	Booleano. Para habilitar o retorno da matriz de uso de estrada para geocódigos reversos no nível da rua
returnSpeedLimit	query		boolean	Booleano. Para habilitar o retorno do limite de velocidade postado
roadUse	query		RoadUseType[]	Para restringir os códigos geográficos 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, Rampa, 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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN. 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 da ID do Microsoft Entra. 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 usar a segurança da ID do Microsoft Entra no Azure Mapas, consulte os artigos de a seguir para obter diretrizes.

Respostas

Nome	Tipo	Description
200 OK	ReverseSearchAddressResult	OKEY
Other Status Codes	ErrorResponse	Ocorreu um erro inesperado.

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-id para 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 quando você Criar uma conta do 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 mestra na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o aplicativos cliente confidenciais abordagem para acessar AS APIs REST do Azure Mapas 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 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 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

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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 geocodificação reversa, 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 que você mostre os mapas corretos para um determinado país/região para regiões geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN. Consulte exibições com suporte para obter detalhes e 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 retornada: 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 para uma resposta inversa de endereço de pesquisa
RoadUseType	Descreve os possíveis usos de uma estrada.
SearchSummary	Objeto resumo de uma resposta da API de Pesquisa.

Address

Objeto

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 alfa-3 iso
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 uma hierarquia administrativa de primeiro nível de país/região. Esse campo é exibido somente no caso de countrySubdivision ser apresentado de forma abreviada. Só há suporte para EUA, Canadá e Reino Unido.
countryTertiarySubdivision	string	Área Nomeada
crossStreet	string	O nome da rua que está sendo atravessada.
extendedPostalCode	string	Código postal 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 de país/região completo.
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 criar a propriedade `freeformAddress`. `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 valor de `municipality` pode ser diferente do nome comumente conhecido de uma cidade ou cidade. Para o nome comumente conhecido da cidade ou cidade, sugere-se que o valor `localName` seja usado em vez do valor `municipality`.
municipalitySubdivision	string	Sub/Super City
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 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 prédio na rua.

BoundingBoxCompassNotation

Objeto

A caixa delimitadora do local.

Nome	Tipo	Description
entity	Entity	Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.
northEast	string	Latitude nordeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas
southWest	string	Latitude sudoeste, coordenada longitude da caixa delimitadora como floats separados por vírgulas

Entity

Enumeração

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.

Valor	Description
position	Entidade de posição

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GeographicEntityType

Enumeração

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

Valor	Description
Country	nome do país/região
CountrySecondarySubdivision	Município
CountrySubdivision	Estado ou Província
CountryTertiarySubdivision	Área Nomeada
Municipality	Cidade/Cidade
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Vizinhança
PostalCodeArea	Cep/Cep

LatLongPairAbbreviated

Objeto

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

Nome	Tipo	Description
lat	number (double)	Propriedade Latitude
lon	number (double)	Propriedade Longitude

LocalizedMapView

Enumeração

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 geopolicamente disputadas. Diferentes países/regiões têm diferentes modos de exibição 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 Exibir no 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 do Azure Mapas. Exemplo: view=IN.

Consulte exibições com suporte para obter detalhes e ver as exibições disponíveis.

Valor	Description
AE	Emirados Árabes Unidos (Exibição árabe)
AR	Argentina (Exibição argentina)
Auto	Retorne os dados do mapa com base no endereço IP da solicitação.
BH	Bahrein (exibição árabe)
IN	Índia (Modo de Exibição Indiano)
IQ	Iraque (exibição árabe)
JO	Jordânia (exibição árabe)
KW	Kuwait (exibição árabe)
LB	Líbano (exibição árabe)
MA	Marrocos (Vista Marroquina)
OM	Omã (exibição árabe)
PK	Paquistão (Exibição paquistanesa)
PS	Autoridade Palestina (Exibição Árabe)
QA	Catar (exibição árabe)
SA	Arábia Saudita (exibição árabe)
SY	Síria (Exibição árabe)
Unified	Exibição unificada (outros)
YE	Iêmen (exibição árabe)

MatchType

Enumeração

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

Valor	Description
AddressPoint
HouseNumberRange
Street

QueryType

Enumeração

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

Valor	Description
NEARBY	A pesquisa foi realizada em torno de uma certa latitude e longitude com um raio definido
NON_NEAR	A pesquisa foi realizada globalmente, sem ser tendenciosa para uma determinada latitude e longitude, e nenhum raio definido

ResponseFormat

Enumeração

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

Valor	Description
json	o formato de intercâmbio de dados de notação de objeto JavaScript
xml	a linguagem de marcação extensível

ReverseSearchAddressResult

Objeto

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 resumo de uma resposta inversa de endereço de pesquisa

ReverseSearchAddressResultItem

Objeto

Objeto de resultado para 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 Rua
position	string	Propriedade Position na forma de "{latitude},{longitude}"
roadUse	RoadUseType[]	Descreve os possíveis usos de uma estrada.

RoadUseType

Enumeração

Descreve os possíveis usos de uma estrada.

Valor	Description
Arterial
LimitedAccess
LocalStreet
Ramp
Rotary
Terminal

SearchSummary

Objeto

Objeto resumo de uma resposta da API de 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 usado para produzir esses resultados da pesquisa.
queryTime	integer	Tempo gasto resolvendo a consulta, em milissegundos.
queryType	QueryType	O tipo de consulta que está sendo retornada: NEARBY ou NON_NEAR.
totalResults	integer	O número total de resultados encontrados.

Compartilhar via

Search - Get Search Address Reverse

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AADToken

Escopos

subscription-key

SAS Token

Exemplos

Searches addresses for coordinates 37.337,-121.89

Solicitação de exemplo

Resposta de exemplo

Definições

Address

BoundingBoxCompassNotation

Entity

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

LatLongPairAbbreviated

LocalizedMapView

MatchType

QueryType

ResponseFormat

ReverseSearchAddressResult

ReverseSearchAddressResultItem

RoadUseType

SearchSummary

Recursos adicionais