Spatial - Get Closest Point

Referencia

Servicio:: Maps

Versión de la API:: 2022-08-01

Use para obtener el punto más cercano entre un punto base y un conjunto determinado de puntos de destino.

La Get Closest Point API es una solicitud HTTP GET el punto más cercano entre un punto base y un conjunto determinado de puntos en el conjunto de datos cargado por el usuario identificado por udid. El conjunto de puntos de destino lo proporciona un archivo GeoJSON que se carga mediante el servicio registro de datos y al que hace referencia un udid único. El archivo GeoJSON solo puede contener una colección de geometría Point. Si se proporciona, se omitirán multipoint u otras geometrías. El número máximo de puntos aceptados es 100 000. El algoritmo no tiene en cuenta el enrutamiento ni el tráfico. La información devuelta incluye la latitud, la longitud y la distancia más cercanas en metros desde el punto más cercano.

Para probar esta API, puede cargar los datos de ejemplo de ejemplos de Post Closest Point API (Cuerpo de solicitud) mediante el servicio Registro de datos y reemplazar el {udid} de la solicitud de ejemplo siguiente por el udid usado al crear el registro de datos. Para más información, consulte Creación de un registro de datos.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
geography	path	True	string	Ubicación de la cuenta de Azure Maps. Los valores válidos son nosotros (Este de EE. UU., Centro-oeste de EE. UU., Oeste de EE. UU. 2) y eu (Norte de Europa, Oeste de Europa). Este parámetro es necesario cuando se proporciona un `udid` elemento en la solicitud. Por ejemplo, si la cuenta de Azure Maps se encuentra en este de EE. UU., solo se aceptarán las solicitudes a nosotros geography.
api-version	query	True	string	Número de versión de la API de Azure Maps.
lat	query	True	number	Latitud de la ubicación que se pasa. Ejemplo: 48.36.
lon	query	True	number	Longitud de la ubicación que se pasa. Ejemplo: -124.63.
udid	query	True	string	Identificador único que se usa al crear un registro de datos para cargar un objeto FeatureCollection de GeoJSON válido. Consulte RFC 7946 para obtener más información. Todas las propiedades de la característica deben contener `geometryId`, que se usa para identificar la geometría y distingue mayúsculas de minúsculas. Para obtener más información sobre el servicio de registro de datos, consulte Creación del registro de datos.
numberOfClosestPoints	query		integer	Número de puntos más cercanos esperados de la respuesta. Valor predeterminado: 1, mínimo: 1 y máximo: 50

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Id. de Entra de Microsoft. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar la seguridad de id. de Entra de Microsoft en Azure Maps, consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	ClosestPointResponse	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de Microsoft Entra OAuth 2.0 . Cuando se empareja con el control de acceso basado en rol de Azure , se puede usar para controlar el acceso a las API REST de Azure Maps. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias cuentas de recursos o subrecursos de Azure Maps. Se puede conceder acceso a cualquier usuario, grupo o entidad de servicio mediante un rol integrado o un rol personalizado compuesto por uno o varios permisos para las API REST de Azure Maps.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso de Azure Maps solicita acceso la aplicación. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de id. de Microsoft Entra. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Para obtener más información sobre la plataforma de identidad de Microsoft, consulte Introducción a la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

subscription-key

Se trata de una clave compartida que se aprovisiona al crear un recurso de Azure Maps a través del plano de administración de Azure mediante Azure Portal, PowerShell, la CLI, los SDK de Azure o las API REST.

Con esta clave, cualquier aplicación está autorizada para acceder a todas las API REST. En otras palabras, estos se pueden tratar actualmente como claves maestras para la cuenta para la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el acceso de servidor a servidor de las API REST de Azure Maps donde esta clave se puede almacenar de forma segura.

Tipo: apiKey
En: header

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en rol de Azure y el control específico a la expiración, la tasa y las regiones de uso para el token determinado. En otras palabras, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de asignación para limitar la representación del abuso y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

GetClosestPoint

Solicitud de ejemplo

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

Respuesta de muestra

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"
    }
  ]
}

Definiciones

Nombre	Description
ClosestPoint	Objeto de entrada de resultado de punto más cercano
ClosestPointResponse	Este objeto se devuelve desde una llamada correcta al punto más cercano espacial.
ClosestPointSummary	Objeto Summary de punto más cercano
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
JsonFormat	Formato deseado de la respuesta. Solo se admite el formato `json`.
LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

ClosestPoint

Objeto de entrada de resultado de punto más cercano

Nombre	Tipo	Description
distanceInMeters	number	Distancia en metros del punto de origen al punto más cercano
geometryId	string	El identificador único identifica una geometría.
position	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

ClosestPointResponse

Este objeto se devuelve desde una llamada correcta al punto más cercano espacial.

Nombre	Tipo	Description
result	ClosestPoint[]	Matriz de resultados de punto más cercana
summary	ClosestPointSummary	Objeto Summary de punto más cercano

ClosestPointSummary

Objeto Summary de punto más cercano

Nombre	Tipo	Description
information	string	Procesamiento de información
sourcePoint	LatLongPairAbbreviated	Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".
udid	string	Identificador de datos único (udid) para el contenido cargado

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

JsonFormat

Formato deseado de la respuesta. Solo se admite el formato json.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript

LatLongPairAbbreviated

Una ubicación representada como una latitud y longitud con nombres cortos "lat" & "lon".

Nombre	Tipo	Description
lat	number	Latitude (propiedad)
lon	number	Longitud (propiedad)

Compartir a través de