Route - Post Snap To Roads

Snap to Roads API acepta datos de punto GPS, representados como coordenadas de longitud y latitud, y genera puntos que se alinean con las carreteras existentes en un mapa. Este proceso, conocido como "acoplamiento a carreteras", genera una serie de objetos que trazan un trazado siguiendo estrechamente la red de carreteras. Los datos resultantes incluyen nombres de carretera y sus respectivos límites de velocidad, pertinentes para los segmentos recorridos.

Además, snap to roads API ofrece una característica de interpolación, que refina los puntos GPS para crear una ruta más suave que se adhiere a la geometría de la carretera. Esta funcionalidad es especialmente beneficiosa para el seguimiento de recursos y mejorar la visualización de datos en las aplicaciones de asignación.

Para información sobre la disponibilidad de rutas en países/regiones, véase Azure Maps cobertura de enrutamiento.

POST https://atlas.microsoft.com/route/snapToRoads?api-version=2025-01-01

Parámetros de identificador URI

Encabezado de la solicitud

Media Types: "application/geo+json"

Cuerpo de la solicitud

Media Types: "application/geo+json"

Respuestas

Seguridad

AADToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para las APIs REST de Azure Maps.

Para implementar escenarios, se recomienda ver 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.

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

Ámbitos

subscription-key

Esta es una clave compartida que se provisiona al crear un recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, Azure SDKs o APIs 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.

Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el acceso servidor a servidor de las APIs REST de Azure Maps, donde esta clave pueda almacenarse de forma segura.

Tipo: apiKey
En: header

SAS Token

Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión Azure mediante portal Azure, PowerShell, CLI, Azure SDKs o APIs REST.

Con este token, cualquier aplicación está autorizada para acceder mediante Azure a controles de acceso basados en roles y a un control minucioso de la expiración, tasa y región(es) de uso para el token en particular. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controle 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 cuenta de mapa de limitar el abuso de representación y renovar periódicamente el token de SAS.

Tipo: apiKey
En: header

Ejemplos

Successfully retrieve snap to roads points with additional parameters in the body

POST https://atlas.microsoft.com/route/snapToRoads?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336729,
          47.590868
        ],
        "type": "Point"
      },
      "properties": {}
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336042,
          47.601604
        ],
        "type": "Point"
      },
      "properties": {}
    }
  ],
  "includeSpeedLimit": true,
  "travelMode": "driving"
}

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336769,
          47.590885
        ],
        "type": "Point"
      },
      "properties": {
        "inputIndex": 0,
        "isInterpolated": false,
        "name": "State Rte-99 N",
        "speedLimitInKilometersPerHour": 80
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336008,
          47.601609
        ],
        "type": "Point"
      },
      "properties": {
        "inputIndex": 1,
        "isInterpolated": false,
        "name": "State Rte-99 N",
        "speedLimitInKilometersPerHour": 80
      }
    }
  ]
}

Definiciones

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

InputSnapToRoadsFeaturesItem

Especifica el ajuste de entrada a los puntos de carretera. GeoJSON objeto de característica y propiedades adicionales. Consulte RFC 7946 para obtener más información.

MapsErrorDetail

Detalle del error.

MapsErrorResponse

Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

PointGeometry

El punto de origen pasado como un objeto Geometry válido GeoJSON, desde el que se debe calcular el polígono de intervalo. Consulte RFC 7946 para obtener más información.

Note: la API ajustará el punto de origen solicitado a la red de carreteras más cercana y la usará para el cálculo del intervalo. Se devolverá como punto de center en la respuesta.

SnapToRoadFeaturesItem

Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.

SnapToRoadsFeatureProperties

Ajustar a las propiedades De carreteras.

SnapToRoadsRequest

Este objeto es el cuerpo de la solicitud.

SnapToRoadsResponse

Este objeto se devuelve de una llamada correcta.

SnapToRoadsTravelModeEnum

Especifica el perfil de enrutamiento para ajustar los puntos. Si no se especifica, el modo predeterminado es "conducción", que optimiza los puntos acoplados para las rutas de conducción.