Partilhar via


Search - Get Search Address Reverse Cross Street

Use para obter informações de localização de rua cruzada a partir de coordenadas de latitude e longitude.

A API Get Search Address Reverse Cross Street é uma solicitação de GET HTTP que retorna a rua transversal mais próxima quando determinadas coordenadas de latitude e longitude. Pode haver momentos em que você precise traduzir uma coordenada (exemplo: 37.786505, -122.3862) em uma rua transversal compreensível por humanos. Na maioria das vezes, isso é necessário em aplicativos de rastreamento onde você recebe um feed GPS do dispositivo ou ativo e deseja saber qual endereço onde a coordenada está localizada. Este ponto de extremidade retornará informações de rua cruzada para uma determinada coordenada.

GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/search/address/reverse/crossStreet/{format}?api-version=1.0&query={query}&limit={limit}&heading={heading}&radius={radius}&language={language}&view={view}

Parâmetros do URI

Name Em Necessá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 da versão da API do Azure Maps.

query
query True

number[]

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

heading
query

integer

minimum: -360
maximum: 360

A direção 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 em que os resultados da pesquisa devem ser retornados. Deve ser uma das tags de idioma IETF suportadas, sem distinção entre maiúsculas e 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 suportados para obter detalhes.

limit
query

integer

minimum: 1
maximum: 100

Número máximo de respostas que serão devolvidas. Padrão: 10, mínimo: 1 e máximo: 100

radius
query

integer

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

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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

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 Microsoft Entra ID. 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 Microsoft Entra ID no Azure Maps, consulte os seguintes artigos para obter orientação.

Respostas

Name Tipo Description
200 OK

ReverseSearchCrossStreetAddressResult

OK

Other Status Codes

ErrorResponse

Ocorreu um erro inesperado.

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

Esta é uma chave compartilhada que é provisionada quando você Criar uma conta do Azure Maps no portal do Azure ou usando PowerShell, CLI, SDKs do Azure ou API REST.

Com essa chave, qualquer aplicativo pode acessar todas as APIs REST. Em outras palavras, essa chave pode ser usada como uma chave mestra na conta em que eles são emitidos.

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

Tipo: apiKey
Em: query

SAS Token

Este é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no de recursos do Azure Maps por meio do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

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 Map para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

Search address of the nearest intersection/crossroad

Pedido de amostra

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

Resposta da amostra

{
  "summary": {
    "numResults": 1,
    "queryTime": 41
  },
  "addresses": [
    {
      "address": {
        "streetName": "East Santa Clara Street & North 2nd Street",
        "crossStreet": "East Santa Clara Street",
        "municipalitySubdivision": "San Jose, Downtown San Jose",
        "municipality": "San Jose",
        "countrySecondarySubdivision": "Santa Clara",
        "countryTertiarySubdivision": "San Jose",
        "countrySubdivisionCode": "CA",
        "postalCode": "95113",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "East Santa Clara Street & North 2nd Street, San Jose, CA 95113",
        "countrySubdivisionName": "California"
      },
      "position": "37.33666,-121.88951"
    }
  ]
}

Definições

Name 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

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

LatLongPairAbbreviated

Um local representado como uma 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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

QueryType

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

ResponseFormat

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

ReverseSearchCrossStreetAddressResult

Este objeto é retornado de uma chamada CrossStreet reversa de endereço de pesquisa bem-sucedida

ReverseSearchCrossStreetAddressResultItem

Objeto de resultado para uma resposta de rua cruzada reversa de endereço de pesquisa

SearchSummary

Objeto de resumo para uma resposta da API de pesquisa.

Address

O endereço do resultado

Name Tipo Description
boundingBox

BoundingBoxCompassNotation

A caixa delimitadora do local.

buildingNumber

string

O número do edifício na rua. DEPRECATED, use 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 ISO alpha-3 do país

countrySecondarySubdivision

string

Condado

countrySubdivision

string

Distrito

countrySubdivisionCode

string

countrySubdivisionCode prefixada por countryCode ( countryCode-countrySubdivisionCode ) e o hífen forma o código ISO 3166-2. Exemplos: TX para o Texas, SCT para a 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. Este campo aparece apenas no caso de paísSubdivisão ser apresentado de forma abreviada. Apenas suportado 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, 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 é usado para construir a propriedade freeformAddress. localName representa o município postal. Dependendo da localização, localName é o nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido de uma cidade ou vila, use localName em vez de municipality.

municipality

string

Cidade
Nota: municipality representa o município residencial. Dependendo da localização, o valor municipality pode diferir do nome comumente conhecido de uma cidade ou vila. Para o nome comumente conhecido da cidade ou vila, sugere-se que o valor localName seja usado em vez do valor municipality.

municipalitySubdivision

string

Sub / Super Cidade

neighbourhood

string

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

postalCode

string

Código Postal / Código Postal

routeNumbers

string[]

Os códigos utilizados para identificar inequivocamente a rua

street

string

O nome da rua. DEPRECATED, 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 edifício na rua.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Name 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, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas

southWest

string

latitude sudoeste, coordenadas de longitude da caixa delimitadora como flutuadores separados por vírgulas

Entity

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

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

ErrorAdditionalInfo[]

O erro informações adicionais.

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

Name Tipo Description
error

ErrorDetail

O objeto de erro.

LatLongPairAbbreviated

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

Name Tipo Description
lat

number (double)

Propriedade Latitude

lon

number (double)

Propriedade Longitude

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 geopoliticamente disputadas. Diferentes países/regiões têm visões diferentes dessas regiões, e o parâmetro View permite que seu aplicativo esteja em conformidade com a exibição exigida pelo país/região que seu aplicativo será atendido. Por padrão, o parâmetro View é definido como "Unified", mesmo que você não o tenha definido na solicitação. É da sua responsabilidade determinar a localização dos seus utilizadores e, em seguida, definir o parâmetro View corretamente para essa localização. 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 Maps deve ser usado em conformidade com as leis aplicáveis, incluindo aquelas relacionadas ao mapeamento, do país/região onde mapas, imagens e outros dados e conteúdo de terceiros que você está autorizado a acessar por meio do Azure Maps são disponibilizados. Exemplo: view=IN.

Consulte de Visualizações Suportadas para obter detalhes e ver as Visualizações disponíveis.

Valor Description
AE

Emirados Árabes Unidos (Vista árabe)

AR

Argentina (Vista Argentina)

Auto

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

BH

Bahrein (Vista árabe)

IN

Índia (Vista indiana)

IQ

Iraque (Vista árabe)

JO

Jordânia (Vista árabe)

KW

Kuwait (Vista árabe)

LB

Líbano (Vista árabe)

MA

Marrocos (Vista Marroquina)

OM

Omã (Vista árabe)

PK

Paquistão (Vista paquistanesa)

PS

Autoridade Palestiniana (Vista árabe)

QA

Qatar (Vista árabe)

SA

Arábia Saudita (Vista árabe)

SY

Síria (Vista árabe)

Unified

Modo de Exibição Unificado (Outros)

YE

Iémen (Vista árabe)

QueryType

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

Valor Description
NEARBY

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

NON_NEAR

A pesquisa foi realizada globalmente, sem polarização para uma determinada latitude e longitude, e sem raio definido

ResponseFormat

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

ReverseSearchCrossStreetAddressResult

Este objeto é retornado de uma chamada CrossStreet reversa de endereço de pesquisa bem-sucedida

Name Tipo Description
addresses

ReverseSearchCrossStreetAddressResultItem[]

Matriz de endereços

summary

SearchSummary

Objeto de resumo para uma resposta de rua cruzada reversa de endereço de pesquisa

ReverseSearchCrossStreetAddressResultItem

Objeto de resultado para uma resposta de rua cruzada reversa de endereço de pesquisa

Name Tipo Description
address

Address

O endereço do resultado

position

string

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

SearchSummary

Objeto de resumo para uma resposta da API de pesquisa.

Name Tipo Description
fuzzyLevel

integer

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

geoBias

LatLongPairAbbreviated

Indicação de quando o motor de busca interno aplicou um viés geoespacial para melhorar a classificação dos resultados. Em alguns métodos, isso pode ser afetado pela definição dos parâmetros lat e lon, quando disponíveis. Noutros casos, é puramente interna.

limit

integer

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

numResults

integer

Número de resultados na resposta.

offset

integer

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

query

string

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

queryTime

integer

Tempo gasto na resolução da consulta, em milissegundos.

queryType

QueryType

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

totalResults

integer

O número total de Resultados encontrados.