Spatial - Get Closest Point

Referência

Service:: Maps

API Version:: 2022-08-01

Utilize para obter o ponto mais próximo entre um ponto base e um determinado conjunto de pontos de destino.

A Get Closest Point API é um pedido HTTP GET o ponto mais próximo entre um ponto base e um determinado conjunto de pontos no conjunto de dados carregado pelo utilizador identificado pelo udid. O conjunto de pontos de destino é fornecido por um ficheiro GeoJSON que é carregado com o serviço registo de dados e referenciado por uma udid exclusiva. O ficheiro GeoJSON só pode conter uma coleção de geometria de Ponto. Se for fornecido, o MultiPoint ou outras geometrias serão ignoradas. O número máximo de pontos aceites é 100 000. O algoritmo não tem em conta o encaminhamento ou o tráfego. As informações devolvidas incluem a latitude de ponto mais próxima, a longitude e a distância em metros a partir do ponto mais próximo.

Para testar esta API, pode carregar os dados de exemplo dos exemplos da API Post Closest Point (Corpo do Pedido) com o serviço Registo de dados e substituir o {udid} do pedido de exemplo abaixo pelo udid utilizado ao criar o registo de dados. Para obter mais informações, veja Como criar um registo de dados.

GET https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}

With optional parameters:

GET https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
format	path	True	JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
geography	path	True	string	Localização da Conta Azure Maps. Os valores válidos são nós (E.U.A. Leste, E.U.A. Centro-Oeste, E.U.A. Oeste 2) e eu (Europa do Norte, Europa Ocidental). Este parâmetro é necessário quando um `udid` é fornecido no pedido. Por exemplo, se a Conta de Azure Maps estiver localizada na região E.U.A. Leste, apenas serão aceites pedidos de geografia.
api-version	query	True	string	Número da versão da API Azure Maps.
lat	query	True	number	A latitude da localização que está a ser transmitida. Exemplo: 48.36.
lon	query	True	number	A longitude da localização que está a ser transmitida. Exemplo: -124.63.
udid	query	True	string	O ID exclusivo utilizado ao criar um Registo de dados para carregar um objeto GeoJSON FeatureCollection válido. Consulte RFC 7946 para obter detalhes. Todas as propriedades da funcionalidade devem conter `geometryId`, que é utilizada para identificar a geometria e é sensível às maiúsculas e minúsculas. Para obter mais informações sobre o serviço de registo de dados, veja Como criar um registo de dados.
numberOfClosestPoints	query		integer	O número de pontos mais próximos esperados da resposta. Predefinição: 1, mínimo: 1 e máximo: 50

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	ClosestPointResponse	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.

Notas

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 está 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Esta é uma chave partilhada que é aprovisionada ao criar um 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 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 Azure Maps onde esta chave pode ser armazenada de forma segura.

Type: apiKey
In: header

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.

Type: apiKey
In: header

Exemplos

GetClosestPoint

Sample Request

HTTP

GET https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=47.622942&lon=-122.316456

Sample Response

Status code:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "10 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.51615340677395,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}

Definições

Name	Description
ClosestPoint	Objeto de Entrada de Resultado de Ponto Mais Próximo
ClosestPointResponse	Este objeto é devolvido de uma chamada de Ponto Mais Próximo Espacial com êxito
ClosestPointSummary	Objeto Resumo de Ponto Mais Próximo
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
JsonFormat	Formato pretendido da resposta. Apenas `json` o formato é suportado.
LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".

ClosestPoint

Objeto de Entrada de Resultado de Ponto Mais Próximo

Name	Tipo	Description
distanceInMeters	number	A distância em metros desde o ponto de origem até ao ponto mais próximo
geometryId	string	O ID exclusivo identifica uma geometria
position	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".

ClosestPointResponse

Este objeto é devolvido de uma chamada de Ponto Mais Próximo Espacial com êxito

Name	Tipo	Description
result	ClosestPoint[]	Matriz de Resultados de Ponto Mais Próximo
summary	ClosestPointSummary	Objeto Resumo de Ponto Mais Próximo

ClosestPointSummary

Objeto Resumo de Ponto Mais Próximo

Name	Tipo	Description
information	string	A processar informações
sourcePoint	LatLongPairAbbreviated	Uma localização representada como uma latitude e longitude com nomes curtos "lat" & "lon".
udid	string	Um ID de dados exclusivo (udid) para o conteúdo carregado

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.

JsonFormat

Formato pretendido da resposta. Apenas json o formato é suportado.

Name	Tipo	Description
json	string	Formato JavaScript Object Notation Data Interchange

LatLongPairAbbreviated

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

Name	Tipo	Description
lat	number	Propriedade Latitude
lon	number	Propriedade Longitude