Route - Post Snap To Roads

A API Snap to Roads aceita dados de pontos GPS, representados como coordenadas de longitude e latitude, e gera pontos que se alinham com as estradas existentes em um mapa. Este processo, conhecido como "encaixar em estradas", produz uma série de objetos que traçam um caminho seguindo de perto a rede rodoviária. Os dados resultantes incluem nomes de estradas e seus respetivos limites de velocidade, pertinentes aos segmentos percorridos.

Além disso, a API Snap to Roads oferece um recurso de interpolação, que refina os pontos GPS para criar uma rota mais suave que adere à geometria da estrada. Essa funcionalidade é especialmente benéfica para o rastreamento de ativos e para melhorar a visualização de dados em aplicativos de mapeamento.

Para obter informações sobre a disponibilidade de roteamento em países/regiões, consulte cobertura de roteamento do Azure Maps.

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

Parâmetros do URI

Cabeçalho do Pedido

Media Types: "application/geo+json"

Corpo do Pedido

Media Types: "application/geo+json"

Respostas

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.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

subscription-key

Essa é uma chave compartilhada que é provisionada ao criar um 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 essa chave, qualquer aplicativo está autorizado a acessar todas as APIs REST. Por outras palavras, estas podem atualmente ser tratadas como chaves mestras para a conta para a qual foram emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar o acesso de servidor para servidor das APIs REST do Azure Maps onde essa chave pode ser armazenada com segurança.

Tipo: apiKey
Em: header

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

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

Definições

FeaturesItemTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é Feature. Para obter mais informações, consulte RFC 7946.

FeatureTypeEnum

Especifica o tipo de GeoJSON. O único tipo de objeto suportado é FeatureCollection. Para obter mais informações, consulte RFC 7946.

GeoJsonPoint

Um tipo de geometria GeoJSON Point válido. Consulte RFC 7946 para obter detalhes.

InputSnapToRoadsFeaturesItem

Especifica o ajuste de entrada aos pontos de estrada. GeoJSON objeto de recurso e propriedades adicionais. Consulte RFC 7946 para obter detalhes.

MapsErrorDetail

O detalhe do erro.

MapsErrorResponse

Resposta de erro comum para APIs do Azure Maps para retornar detalhes de erro para operações com falha.

MapsInnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

PointGeometry

O ponto de origem passou como um objeto GeoJSON Geometry válido, a partir do qual o polígono de intervalo deve ser calculado. Consulte RFC 7946 para obter detalhes.

Note: A API encaixará o ponto de origem solicitado na rede rodoviária mais próxima e o usará para o cálculo do alcance. Ele será retornado como um ponto center na resposta.

SnapToRoadFeaturesItem

Objeto de recurso GeoJSON que contém o objeto Geometry e propriedades adicionais da rota.

SnapToRoadsFeatureProperties

Ajuste às propriedades de Estradas.

SnapToRoadsRequest

Este objeto é o corpo da solicitação.

SnapToRoadsResponse

Este objeto é retornado de uma chamada bem-sucedida.

SnapToRoadsTravelModeEnum

Especifica o perfil de roteamento para ajustar os pontos. Se não for especificado, o modo padrão é "condução", que otimiza os pontos ajustados para rotas de condução.