Route - Post Snap To Roads

Interfejs API przyciągania do dróg akceptuje dane punktów GPS, reprezentowane jako współrzędne geograficzne i współrzędne geograficzne oraz generuje punkty, które są zgodne z istniejącymi drogami na mapie. Ten proces, znany jako "przyciąganie do dróg", tworzy serię obiektów, które śledzą ścieżkę ściśle po sieci drogowej. Wynikowe dane obejmują nazwy dróg i ich odpowiednie ograniczenia prędkości, odpowiednie dla przechodzonych segmentów.

Ponadto interfejs API Snap to Roads oferuje funkcję interpolacji, która uściśli punkty GPS, aby stworzyć łagodniejszą trasę, która jest zgodna z geometrią drogi. Ta funkcja jest szczególnie przydatna w przypadku śledzenia zasobów i ulepszania wizualizacji danych w aplikacjach mapowania.

Aby uzyskać informacje o dostępności routingu w krajach/regionach, zobacz Azure Maps pokrycie routingu.

POST {endpoint}/route/snapToRoads?api-version=2025-01-01

Parametry identyfikatora URI

Nagłówek żądania

Media Types: "application/geo+json"

Treść żądania

Media Types: "application/geo+json"

Odpowiedzi

Zabezpieczenia

AadToken

Są to przepływy Microsoft Entra OAuth 2.0. W połączeniu z Azure zarządzaniem dostępem opartym na rolach może być używany do kontroli dostępu do Azure Maps API REST. Kontrola dostępu oparta na rolach Azure służy do wyznaczania dostępu do jednego lub więcej kont zasobów lub podzasobów Azure Maps. Każdy użytkownik, grupa lub podmiot usługowy może otrzymać dostęp poprzez wbudowaną rolę lub niestandardową rolę składającą się z jednego lub więcej uprawnień do Azure Maps API REST.\n\nAby zaimplementować scenariusze, zalecamy zapoznanie się z koncepcjami authentication concepts. Podsumowując, ta definicja bezpieczeństwa zapewnia rozwiązanie do modelowania aplikacji(-ów) za pomocą obiektów zdolnych do kontroli dostępu do określonych API i zakresów.\n\n#### Uwagi\n* Ta definicja bezpieczeństwa wymaga użycia nagłówka x-ms-client-id do wskazania, do którego Azure Maps zasobu aplikacja żąda dostępu. Można ją uzyskać z API zarządzania Maps.\n* \nAuthorization URL jest specyficzny dla instancji Azure chmury publicznej. Suwerenne chmury mają unikalne adresy URL autoryzacji oraz konfiguracje Microsoft Entra ID. \n* \nKontrola dostępu oparta na rolach Azure jest konfigurowana z płaszczyzny zarządzania Azure za pośrednictwem Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n* \nWykorzystanie Azure Maps Web SDK umożliwia konfigurację aplikacji dla wielu zastosowań.\n* Aby uzyskać więcej informacji o Platforma tożsamości Microsoft, zobacz przegląd Platforma tożsamości Microsoft przegląd.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

subscription-key

Jest to klucz współdzielony, który jest przydzielany podczas Tworzenia konta Azure Maps w portalu Azure lub za pomocą PowerShell, CLI, Azure SDKs lub REST API.\n\n Dzięki temu kluczowi każda aplikacja może uzyskać dostęp do wszystkich API REST. Innymi słowy, ten klucz może być używany jako klucz główny na koncie, na którym są wydawane.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy stosowanie podejścia confidential client applications do dostępu do API REST Azure Maps i bezpiecznie przechowywać klucz.

Typ: apiKey
W: header

SAS Token

Jest to token podpisu współdzielonego dostępu tworzony na podstawie operacji List SAS na Azure Maps resource przez płaszczyznę zarządzania Azure za pomocą Azure portalu, PowerShell, CLI, Azure SDKs lub API REST.\n\n Dzięki temu tokenowi każda aplikacja jest autoryzowana do dostępu za pomocą Azure kontrola dostępu oparta na rolach oraz precyzyjna kontrola do terminu wygaśnięcia, tempa i regionu użycia danego tokena. Innymi słowy, token SAS może być używany do umożliwienia aplikacjom kontrolowania dostępu w sposób bezpieczniejszy niż klucz współdzielony.\n\n W przypadku aplikacji udostępnionych publicznie zalecamy skonfigurowanie konkretnej listy dozwolonych źródeł na zasobach konta Map , aby ograniczyć nadużycia renderowania i regularnie odnawiać Token SAS.

Typ: apiKey
W: header

Przykłady

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

POST {endpoint}/route/snapToRoads?api-version=2025-01-01

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

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

Definicje

FeaturesItemTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.

FeatureTypeEnum

Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.

GeoJsonObjectType

Określa typ GeoJSON. Musi być jednym z dziewięciu prawidłowych typów obiektów GeoJSON — Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature i FeatureCollection.

GeoJsonPoint

Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.

InputSnapToRoadsFeaturesItem

Określa przyciąganie danych wejściowych do punktów dróg. GeoJSON obiekt funkcji i dodatkowe właściwości. Szczegółowe informacje można znaleźć w dokumencie RFC 7946 .

MapsErrorDetail

Szczegóły błędu.

MapsErrorResponse

Typowa odpowiedź na błędy dla API Azure Maps do zwracania szczegółów błędu dla nieudanych operacji.

MapsInnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

SnapToRoadFeaturesItem

Obiekt funkcji GeoJSON, który zawiera obiekt Geometry i dodatkowe właściwości trasy.

SnapToRoadsFeatureProperties

Przyciągaj do właściwości Drogi.

SnapToRoadsRequest

Ten obiekt jest treścią żądania.

SnapToRoadsResponse

Ten obiekt jest zwracany z pomyślnego wywołania.

SnapToRoadsTravelModeEnum

Określa profil routingu do przyciągania punktów. Jeśli nie określono, domyślny tryb to "jazda", który optymalizuje przyciągane punkty dla tras jazdy.