Route - Post Route Matrix

De Route Matrix-API is een HTTP-POST-aanvraag waarmee een matrix met routesamenvattingen kan worden berekend voor een set routes die zijn gedefinieerd door oorsprongs- en doellocaties met behulp van een synchronisatieaanvraag. Voor elke opgegeven oorsprong berekent de service de kosten van routering van die oorsprong naar elke opgegeven bestemming. De set van oorsprongen en de set van bestemmingen kunnen worden beschouwd als de kolom- en rijkoppen van een tabel, en elke cel in de tabel bevat de kosten voor het routeren van de oorsprong naar de bestemming voor die cel. Route Matrices kunnen worden berekend voor rij-, wandel- en vrachtwagenroutes. Een foodleveringsbedrijf heeft bijvoorbeeld 20 chauffeurs en ze moeten de dichtstbijzijnde chauffeur vinden om de levering van het restaurant op te halen. Om deze use case op te lossen, kunnen ze de Route Matrix-API aanroepen en de reiskosten gebruiken om de chauffeurs te sorteren op hun werkelijke reisafstand of -tijd van het restaurant.

Route Matrices worden gebruikt in verschillende soorten toepassingen, meestal om het reizende verkoperprobleem (TSP) en voertuigrouteringsprobleem (VRP) op te lossen. Voor elk oorspronkelijk doelpaar in de matrix worden de reistijd en afstand geretourneerd. U kunt de berekende kosten gebruiken om te bepalen welke gedetailleerde routes u wilt berekenen met behulp van de ROUTEBESCHRIJVING-API.

De maximale grootte van een matrix voor een synchronisatieaanvraag is 2500 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen).

Synchrone routematrixaanvraag verzenden

Als voor uw scenario synchrone aanvragen zijn vereist en de maximale grootte van de matrix kleiner is dan of gelijk is aan 2500, kunt u synchrone aanvragen indienen. De maximale grootte van een matrix voor deze API is 2500 (het aantal oorsprongen vermenigvuldigd met het aantal bestemmingen). Met deze beperking in gedachten zijn voorbeelden van mogelijke matrixdimensies: 50x50, 60x40, 90x20 (het hoeft niet vierkant te zijn).

API-beperkingen

De synchrone verwerking van matrix is het meest geschikt voor snelle, kleine matrices van routeberekening. Als u grotere matrices en zware routeberekeningen wilt berekenen, gebruikt u het asynchrone eindpunt. De volgende beperking is van toepassing op de synchrone aanvragen. Als geen van de rijen in de volgende tabel overeenkomt met de parameters van de aanvraag, voldoet de aanvraag niet aan de vereisten en wordt deze niet verwerkt.

Voorbeelden:

• Aanvraag van matrix van 10x20 met traffic=live: deze aanvraag wordt verwerkt met een begrenzingsvaklimiet, omdat deze overeenkomt met een limiet van maximaal 200, waaronder begrenzingsvakbeperkingen.

• Aanvraag van 10x20-matrix met standaardparameters (traffic=historical): Deze aanvraag wordt verwerkt zonder een limiet voor het begrenzingsvak, omdat deze overeenkomt met een limiet van maximaal 2500, waardoor geen beperkingen voor begrenzingsvakken worden opgelegd.

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

URI-parameters

Aanvraagkoptekst

Media Types: "application/geo+json"

Aanvraagbody

Media Types: "application/geo+json"

Antwoorden

Beveiliging

AADToken

Dit zijn de Microsoft Entra OAuth 2.0 Flows. Wanneer deze is gekoppeld aan op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang aan te wijzen tot een of meer Azure Maps-resourceaccounts of subresources. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Voor het implementeren van scenario's raden we u aan om verificatieconceptente bekijken. Kortom, deze beveiligingsdefinitie biedt een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen uitvoeren voor specifieke API's en bereiken.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

subscription-key

Dit is een gedeelde sleutel die wordt ingericht bij het maken van een Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met deze sleutel is elke toepassing gemachtigd voor toegang tot alle REST API's. Met andere woorden, deze kunnen momenteel worden behandeld als hoofdsleutels voor het account waarvoor ze worden uitgegeven.

Voor openbaar blootgestelde toepassingen wordt aangeraden server-naar-servertoegang te gebruiken van Azure Maps REST API's waar deze sleutel veilig kan worden opgeslagen.

Type: apiKey
In: header

SAS Token

Dit is een shared access Signature-token dat wordt gemaakt op basis van de bewerking List SAS op de Azure Maps-resource via het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's.

Met dit token is elke toepassing gemachtigd voor toegang met op rollen gebaseerd toegangsbeheer van Azure en gedetailleerd beheer tot de vervaldatum, snelheid en regio(s) van gebruik voor het specifieke token. Met andere woorden, het SAS-token kan worden gebruikt om toepassingen toe te staan toegang op een veiligere manier te beheren dan de gedeelde sleutel.

Voor openbaar blootgestelde toepassingen wordt aangeraden een specifieke lijst met toegestane origins te configureren voor de resource van het Account toewijzen om het genereren van misbruik te beperken en het SAS-token regelmatig te vernieuwen.

Type: apiKey
In: header

Voorbeelden

Successfully retrieve a route matrix with additional parameters in the body

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck",
  "avoid": [
    "unpavedRoads"
  ]
}

{
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 4
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 21007,
        "durationInSeconds": 21007,
        "distanceInMeters": 492466,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:30:03+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 33623,
        "durationInSeconds": 33623,
        "distanceInMeters": 877028,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T02:00:19+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 19520,
        "durationInSeconds": 19520,
        "distanceInMeters": 427769,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:05:16+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 32070,
        "durationInSeconds": 32070,
        "distanceInMeters": 836080,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T01:34:27+01:00"
      }
    ]
  }
}

Definities

AdrTunnelRestrictionCodeEnum

De ADR-tunnelbeperkingscode. ADR is een Europese overeenkomst met betrekking tot het internationale vervoer van gevaarlijke goederen via de weg. De ADR-tunnelbeperkingscode wordt gebruikt om te bepalen of een voertuig een tunnel mag passeren met beperkingen voor het vervoer van gevaarlijke goederen.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

FeaturesItemTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is Functie. Voor meer informatie, zie RFC 7946.

FeatureTypeEnum

Hiermee geeft u het GeoJSON type. Het enige ondersteunde objecttype is FeatureCollection. Voor meer informatie, zie RFC 7946.

GeoJsonMultiPoint

Een geldig GeoJSON MultiPoint geometrietype. Raadpleeg RFC 7946- voor meer informatie.

InputRouteMatrixFeaturesItem

Hiermee geeft u de invoeroorsprong en doelpunten en aanvullende eigenschappen voor het GeoJSON MultiPoint-functieobject. Raadpleeg RFC 7946 voor meer informatie.

InputRouteMatrixProperties

Hiermee geeft u het eigenschappenobject voor de invoermatrix.

MapsErrorDetail

De foutdetails.

MapsErrorResponse

Veelvoorkomende foutreacties voor Azure Maps-API's voor het retourneren van foutdetails voor mislukte bewerkingen.

MapsInnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

RouteMatrixAsyncResponse

Hiermee geeft u de rijinstructies en aanvullende eigenschappen voor elk manoeuvreerpunt in de route leg.

RouteMatrixAvoidEnum

Hiermee geeft u beperkingen op die de routeberekening moet respecteren bij het bepalen van de route. Vermijd ondersteunt meerdere waarden in een aanvraag en wordt alleen ondersteund voor de rij- en vrachtwagen travelMode.

RouteMatrixFeatureProperties

Eigenschappen van routematrix.

RouteMatrixItemResult

Resultaat van routematrixitem

RouteMatrixOptimizeRouteEnum

Hiermee geeft u de parameter die moet worden gebruikt om de route te optimaliseren. Als dit niet is gedefinieerd, is de standaardwaarde 'snelste' die de route retourneert om de reistijd te minimaliseren.

Voorbeeld: 'optimizeRoute':'snelste'

RouteMatrixRequest

Gebruik dit om een routematrix te verkrijgen met de reistijd en afstand voor alle mogelijke paren in een lijst met oorsprongen en bestemmingen. GeoJSON functieobject en aanvullende eigenschappen. Raadpleeg RFC 7946 voor meer informatie.

RouteMatrixResponse

Dit object wordt geretourneerd vanuit een geslaagde aanroep.

RouteMatrixSummary

Samenvatting voor de routematrixaanvraag

RouteMatrixTrafficEnum

Hiermee geeft u op hoe verkeer wordt overwogen voor computerroutes.

Standaardwaarde: historical

RouteMatrixTravelModeEnum

Hiermee geeft u het reisprofiel waarmee u rekening moet houden bij het berekenen van de matrix. Als dit niet is opgegeven, is de standaardwaarde 'rijden'.

Voorbeeld: "travelMode":"rijden"

RouteMatrixTypeEnum

Hiermee geeft u de oorsprong MultiPoint type en doel MultiPoint type voor de invoermatrix.

RouteMatrixVehicleSpec

Hiermee geeft u de voertuigkenmerken op, zoals voertuighoogte, gewicht, maximale snelheid, type lading, enz. om rekening mee te houden bij het berekenen van de routematrix. Dit helpt bij het vermijden van lage brugmachtigingen, wegbeperkingen, moeilijke bochten om de geoptimaliseerde route te bieden op basis van de voertuigspecificaties. Voertuigkenmerken worden opgegeven in de eigenschap vehicleSpec.

RouteOperationKindEnum

Type asynchrone bewerking

VehicleLoadTypeEnum

Soorten ladingen die kunnen worden geclassificeerd als gevaarlijke materialen en beperkt zijn van sommige wegen. Beschikbare vehicleLoadType-waarden zijn US Hazmat-klassen 1 tot en met 9, plus algemene classificaties voor gebruik in andere landen. Waarden die beginnen met USHazmat zijn voor amerikaanse routering, terwijl andereHazmat moet worden gebruikt voor alle andere landen. vehicleLoadType ondersteunt meerdere waarden in een aanvraag.