다음을 통해 공유

Route - Get Route Directions

서비스:
Maps
API 버전:
1.0

지정된 원점과 대상 간의 경로를 계산하여 지정된 웨이포인트를 통과하는 데 사용합니다.

비고

Azure Maps Route v1 서비스 사용 중지

Azure Maps Route v1 서비스는 이제 더 이상 사용되지 않으며 3/31/28에 사용 중지됩니다. 서비스 중단을 방지하려면 Route v1 서비스에 대한 모든 호출을 업데이트하여 3/31/28까지 Route v2025-01-01 서비스를 사용해야 합니다. 자세한 내용은 Azure Maps Route 1.0 API마이그레이션을 참조하세요.

Get Route Directions API는 지정된 경우 중간 지점을 통과하여 원본과 대상 간의 경로를 반환하는 HTTP GET 요청입니다. 이 경로는 현재 교통량과 요청된 요일 및 시간에 대한 일반적인 도로 속도와 같은 요인을 고려합니다.

반환되는 정보에는 거리, 예상 이동 시간 및 경로 기하 도형의 표현이 포함됩니다. 선택한 옵션에 따라 최적화된 웨이포인트 순서 또는 순서별 순서와 같은 추가 라우팅 정보도 사용할 수 있습니다.

라우팅 서비스는 차량별 소비 모델에 대한 자세한 설명을 위한 매개 변수 집합을 제공합니다. 자세한 내용은 소비 모델참조하세요.

GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
선택적 매개 변수: 
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
format
 path True

ResponseFormat

원하는 응답 형식입니다. 값은 json 또는 xml 수 있습니다.
api-version
 query True

string

Azure Maps API의 버전 번호입니다.
query
 query True

string

경로가 계산되는 좌표이며 콜론으로 구분됩니다. 최소 2개의 좌표가 필요합니다. 첫 번째는 출발지이고 마지막은 경로의 대상입니다. 선택적 좌표 사이는 경로의 중간 지점 역할을 합니다. 최대 150개의 웨이포인트를 전달할 수 있습니다.
accelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

차량이 가속할 때 연료에 저장된 화학 에너지를 운동 에너지로 변환하는 효율성을 지정합니다(즉, KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumedfuelEnergyDensityInMJoulesPerLiter사용하여 소비된 연료를 화학 에너지로 변환하여 얻습니다.

decelerationEfficiency함께 사용해야 합니다.

허용되는 값의 범위는 0.0에서 1/decelerationEfficiency.

합리적인 값 : 연소 모델 : 0.33, 전기 모델 : 0.66
alternativeType
 query

AlternativeRouteType

참조 경로에 비해 계산된 대안의 지정된 계획 기준에 따라 최적도를 제어합니다.
arriveAt
 query

string (date-time)

선택적 표준 시간대 오프셋이 있는 dateTime정의된 대로 값으로 서식이 지정된 대상 지점의 도착 날짜 및 시간입니다. 표준 시간대 오프셋을 지정하지 않으면 대상 지점의 오프셋으로 간주됩니다.

예제:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

arriveAt 매개 변수는 departAt, minDeviationDistance 또는 minDeviationTime함께 사용할 수 없습니다.
auxiliaryPowerInkW
 query

number (double)

보조 시스템을 유지하는 데 사용되는 전력의 양을 kW(킬로와트)로 지정합니다.

AC 시스템, 라디오, 난방 등과 같은 장치 및 시스템으로 인해 소비를 지정하는 데 사용할 수 있습니다.

합리적인 값: 1.7
auxiliaryPowerInLitersPerHour
 query

number (double)

차량의 보조 시스템을 유지하는 데 사용되는 연료의 양을 시간당 리터 단위로 지정합니다.

AC 시스템, 라디오, 난방 등과 같은 장치 및 시스템으로 인해 소비를 지정하는 데 사용할 수 있습니다.

합리적인 값: 0.2
avoid
 query

RouteAvoidType[]

경로를 결정할 때 경로 계산에서 피해야 하는 항목을 지정합니다. 한 요청에서 여러 번 지정할 수 있습니다( 예: '&avoid=motorways&avoid=tollRoads&avoid=ferries'). 경로 범위 요청에서 이미UsedRoads 값을 사용하면 안 됩니다.
computeBestOrder
 query

boolean

경로 길이를 줄이기 위해 빠른 추론 알고리즘을 사용하여 경로 웨이포인트의 순서를 다시 지정합니다. routeType 가장 짧은함께 사용할 때 최상의 결과를 생성합니다. 원본 및 대상은 최적화된 웨이포인트 인덱스에서 제외됩니다. 응답에 원본 및 대상을 포함하려면 원본을 고려하여 모든 인덱스를 1씩 늘인 다음 대상을 최종 인덱스로 추가하세요. 가능한 값은 true 또는 false입니다. True는 가능한 경우 더 나은 순서를 계산하지만 0보다 큰 maxAlternatives 값과 함께 사용하거나 원 웨이포인트와 함께 사용할 수 없습니다. False는 지정된 순서로 위치를 사용하며 routeRepresentation과 함께 사용할 수 없습니다.
computeTravelTimeFor
 query

ComputeTravelTime

다양한 유형의 교통 정보(없음, 기록, 라이브)와 기본 최적 예상 이동 시간을 사용하여 추가 이동 시간을 반환할지 여부를 지정합니다.
constantSpeedConsumptionInkWhPerHundredkm
 query

string

사용량의 속도 종속 구성 요소를 지정합니다.

속도/소비율 쌍의 순서가 지정되지 않은 목록으로 제공됩니다. 이 목록은 소비 곡선의 점을 정의합니다. 목록에 없는 속도에 대한 소비 속도는 다음과 같습니다.

  • 선형 보간을 통해 지정된 속도가 목록의 두 속도 사이에 있는 경우

  • 그렇지 않으면 선형 외삽으로, 목록에서 가장 가까운 두 점으로 결정되는 상수(ΔConsumption/ΔSpeed)를 가정합니다.

목록에는 1~25포인트(포함)가 포함되어야 하며, 동일한 속도에 대해 중복 점을 포함하지 않을 수 있습니다. 단일 지점만 포함된 경우 추가 처리 없이 해당 지점의 사용률이 사용됩니다.

가장 큰 속도에 대해 지정된 소비량은 끝에서 두 번째로 큰 속도보다 크거나 같아야 합니다. 이렇게 하면 외삽이 음수 소비율로 이어지지 않습니다.

마찬가지로 목록에서 가장 작은 두 속도에 대해 지정된 소비 값은 더 작은 속도에 대해 음의 소비율로 이어질 수 없습니다.

사용량 값(kWh/100km로 표시됨)의 유효한 범위는 0.01에서 100000.0 사이입니다.

합리적인 값: 50,8.2:130,21.3

이 매개 변수는 전기 소비 모델필요합니다.
constantSpeedConsumptionInLitersPerHundredkm
 query

string

사용량의 속도 종속 구성 요소를 지정합니다.

콜론으로 구분된 속도 & 소비율 쌍의 순서가 지정되지 않은 목록으로 제공됩니다. 이 목록은 소비 곡선의 점을 정의합니다. 목록에 없는 속도에 대한 소비 속도는 다음과 같습니다.

  • 선형 보간을 통해 지정된 속도가 목록의 두 속도 사이에 있는 경우

  • 그렇지 않으면 선형 외삽으로, 목록에서 가장 가까운 두 점으로 결정되는 상수(ΔConsumption/ΔSpeed)를 가정합니다.

목록에는 1~25포인트(포함)가 포함되어야 하며, 동일한 속도에 대해 중복 점을 포함하지 않을 수 있습니다. 단일 지점만 포함된 경우 추가 처리 없이 해당 지점의 사용률이 사용됩니다.

가장 큰 속도에 대해 지정된 소비량은 끝에서 두 번째로 큰 속도보다 크거나 같아야 합니다. 이렇게 하면 외삽이 음수 소비율로 이어지지 않습니다.

마찬가지로 목록에서 가장 작은 두 속도에 대해 지정된 소비 값은 더 작은 속도에 대해 음의 소비율로 이어질 수 없습니다.

사용량 값(l/100km로 표시됨)의 유효한 범위는 0.01에서 100000.0 사이입니다.

합리적인 값: 50,6.3:130,11.5

참고: 이 매개 변수는 연소 소비 모델데 필요합니다.
currentChargeInkWh
 query

number (double)

현재 전기 에너지 공급을 kWh(킬로와트시)로 지정합니다.

이 매개 변수는 maxChargeInkWh 매개 변수와 공존합니다.

허용되는 값 범위는 maxChargeInkWh0.0입니다.

합리적인 값: 43
currentFuelInLiters
 query

number (double)

리터에서 연료의 현재 공급을 지정합니다.

합리적인 값: 55
decelerationEfficiency
 query

number (double)

minimum: 0
maximum: 1

차량이 감속할 때 운동 에너지를 저장(소비되지 않음) 연료로 변환하는 효율성을 지정합니다(예: ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySavedfuelEnergyDensityInMJoulesPerLiter사용하여 저장된(소비되지 않음) 연료를 에너지로 변환하여 얻습니다.

accelerationEfficiency쌍을 이겨야 합니다.

허용되는 값의 범위는 0.0에서 1/accelerationEfficiency.

합리적인 값 : 연소 모델 : 0.83, 전기 모델 : 0.91
departAt
 query

string (date-time)

선택적 표준 시간대 오프셋이 있는 dateTime정의된 대로 값으로 서식이 지정된 원점에서 출발 날짜 및 시간입니다. 표준 시간대 오프셋을 지정하지 않으면 원점의 오프셋으로 간주됩니다.

  • 기본값: now
  • 기타 값: dateTime

예제:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

departAt 매개 변수는 arriveAt함께 사용할 수 없습니다.
downhillEfficiency
 query

number (double)

minimum: 0
maximum: 1

차량이 고도 손실될 때(즉, ChemicalEnergySaved/PotentialEnergyLost) 잠재적 에너지를 저장(소비되지 않음) 연료로 변환하는 효율성을 지정합니다. ChemicalEnergySavedfuelEnergyDensityInMJoulesPerLiter사용하여 저장된(소비되지 않음) 연료를 에너지로 변환하여 얻습니다.

uphillEfficiency함께 사용해야 합니다.

허용되는 값의 범위는0.0~1/.

합리적인 값 : 연소 모델 : 0.51, 전기 모델 경우 : 0.73
fuelEnergyDensityInMJoulesPerLiter
 query

number (double)

MJ(메가줄)의 1리터 연료에 저장된 화학 에너지의 양을 지정합니다. 저장 또는 소비된 에너지와 연료 간의 변환을 위한 *효율성 매개 변수와 함께 사용됩니다. 예를 들어 에너지 밀도는 휘발유의 경우 34.2MJ/l, 디젤 연료의 경우 35.8MJ/l입니다.

*Efficiency 매개 변수가 설정된 경우 이 매개 변수가 필요합니다.

합리적인 값: 34.2
hilliness
 query

InclineLevel

스릴 넘치는 경로에 대한 언덕의 정도. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.
instructionsType
 query

RouteInstructionsType

지정한 경우 지침 지침이 반환됩니다. instructionsType 매개 변수는 routeRepresentation=none과 함께 사용할 수 없습니다.
language
 query

string

언어 매개 변수는 지침 메시지의 언어를 결정합니다. 적절한 명사(거리, 광장 등의 이름)는 지정된 언어로 반환되거나, 사용할 수 없는 경우 가까운 사용 가능한 언어로 반환됩니다. 허용되는 값은 IETF 언어 태그의 하위 집합입니다. 현재 지원되는 언어는지원되는 언어 섹션에 나열됩니다.

기본값: en-GB
maxAlternatives
 query

integer

minimum: 0
maximum: 5

계산할 원하는 대체 경로 수입니다. 기본값: 0, 최소: 0 및 최대: 5
maxChargeInkWh
 query

number (double)

차량의 배터리에 저장할 수 있는 최대 전기 에너지 공급량(kWh)을 지정합니다.

이 매개 변수는 currentChargeInkWh 매개 변수와 공존합니다.

최소값은 현재ChargeInkWh보다 크거나 같아야 합니다.

합리적인 값: 85
minDeviationDistance
 query

integer

반환되는 모든 대체 경로는 적어도 이 미터 수에 대한 calculateRoute 요청의 원본 지점에서 참조 경로(POST 요청 섹션 참조)를 따릅니다. 경로를 다시 구성할 때만 사용할 수 있습니다. minDeviationDistance 매개 변수는 arriveAt와 함께 사용할 수 없습니다.
minDeviationTime
 query

integer

반환되는 모든 대체 경로는 calculateRoute 요청의 원본 지점에서 최소 이 시간(초)의 참조 경로(POST 요청 섹션 참조)를 따릅니다. 경로를 다시 구성할 때만 사용할 수 있습니다. minDeviationTime 매개 변수는 arriveAt와 함께 사용할 수 없습니다. 기본값은 0입니다. )minDeviationTime_ 0보다 큰 값으로 설정하면 다음과 같은 결과가 나타납니다.

  • calculateRoute 요청의 원본 지점은 입력 참조 경로에 있거나 매우 가깝습니다.
    • 그렇지 않으면 오류가 반환됩니다.
    • 그러나 원점은 입력 참조 경로의 시작 부분에 있을 필요가 없습니다(참조 경로의 현재 차량 위치로 생각할 수 있습니다).
  • calculateRoute Response의 첫 번째 경로로 반환되는 참조 경로는 calculateRoute 요청에 지정된 원본 지점에서 시작됩니다. 원본 지점이 응답에서 제외될 때까지 입력 참조 경로의 초기 부분입니다.
  • minDeviationDistance 및 minDeviationTime 값은 대체 경로가 원점부터 참조 경로를 따라가도록 보장되는 정도를 결정할 있습니다.
  • 경로는 사용해야 합니다..
  • 차량 헤드링 무시됩니다.
report
 query

Report

진단을 위해 보고해야 하는 데이터를 지정합니다. 유일한 가능한 값은 effectiveSettings. API를 호출할 때 사용되는 유효 매개 변수 또는 데이터를 보고합니다. 기본 매개 변수의 경우 기본값은 호출자가 매개 변수를 지정하지 않은 위치에 반영됩니다.
routeRepresentation
 query

RouteRepresentationForBestOrder

응답으로 제공된 경로 집합의 표현을 지정합니다.
routeType
 query

RouteType

요청된 경로의 유형입니다.
sectionType
 query

SectionType[]

경로 응답에서 보고되는 섹션 유형을 지정합니다.

예를 들어 sectionType = 보행자에 적합한 구역만 반환됩니다. 한 요청에서 여러 번 지정할 수 있습니다(예: '§ionType=carTrain§ionType=pedestrian§ionType=motorway'). 기본 sectionType은 travelMode 입력을 참조합니다. 기본적으로 travelMode는 자동차로 설정됩니다.
traffic
 query

boolean

가능한 값:

  • true - 라우팅 중에 사용 가능한 모든 트래픽 정보를 고려하세요.
  • false - 라우팅 중에 현재 트래픽 데이터를 무시합니다. 라우팅 중에는 현재 트래픽 데이터가 무시되지만, 기록 트래픽이 효과적인 도로 속도에 미치는 영향은 여전히 통합되어 있습니다.
travelMode
 query

TravelMode

요청된 경로에 대한 이동 모드입니다. 정의되지 않은 경우 기본값은 'car'입니다. 요청된 travelMode를 전체 경로에 사용할 수 없습니다. 요청된 travelMode를 특정 섹션에 사용할 수 없는 경우 해당 섹션에 대한 응답의 travelMode 요소는 "other"가 됩니다. 여행 모드 버스, 오토바이, 택시 및 밴은 BETA 기능입니다. 일부 영역에서는 전체 제한 데이터를 사용할 수 없습니다.
uphillEfficiency
 query

number (double)

minimum: 0
maximum: 1

차량이 상승 얻을 때 연료에 저장된 화학 에너지를 잠재적 에너지로 변환하는 효율성을 지정합니다(즉, PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumedfuelEnergyDensityInMJoulesPerLiter사용하여 소비된 연료를 화학 에너지로 변환하여 얻습니다.

downhillEfficiency함께 사용해야 합니다.

허용되는 값의 범위는 0.0에서 1/downhillEfficiency.

합리적인 값 : 연소 모델 : 0.27, 전기 모델 경우 : 0.74
vehicleAxleWeight
 query

integer

차량의 차축당 무게(kg)입니다. 값이 0이면 액슬당 가중치 제한이 고려되지 않습니다.
vehicleCommercial
 query

boolean

차량이 상업적 목적으로 사용되는지 여부입니다. 상용 차량은 일부 도로에서 운전할 수 없습니다.
vehicleEngineType
 query

VehicleEngineType

차량의 엔진 유형입니다. 자세한 소비 모델을 지정하면 vehicleEngineType값과 일치해야 합니다.
vehicleHeading
 query

integer

minimum: 0
maximum: 359

실제 북쪽에서 시작하여 시계 방향으로 계속되는 차량의 방향 방향입니다. 북쪽은 0도, 동쪽은 90도, 남쪽은 180도, 서쪽은 270도입니다. 가능한 값 0-359
vehicleHeight
 query

number (double)

차량의 높이(미터)입니다. 값이 0이면 높이 제한이 고려되지 않습니다.
vehicleLength
 query

number (double)

차량의 길이(미터)입니다. 값이 0이면 길이 제한이 고려되지 않습니다.
vehicleLoadType
 query

VehicleLoadType

위험 물질로 분류되고 일부 도로에서 제한될 수 있는 화물 유형입니다. 사용 가능한 vehicleLoadType 값은 미국 Hazmat 클래스 1~9와 다른 국가/지역에서 사용할 일반 분류입니다. USHazmat로 시작하는 값은 미국 라우팅을 위한 것이고 다른 모든 국가/지역에는 otherHazmat을 사용해야 합니다. vehicleLoadType을 여러 번 지정할 수 있습니다. 이 매개 변수는 현재 travelMode=truck에 대해서만 고려됩니다.
vehicleMaxSpeed
 query

integer

차량의 최대 속도(km/hour)입니다. 차량 프로필의 최대 속도는 차량이 고속도로에서 허용되는지 여부를 확인하는 데 사용됩니다.

  • 값이 0이면 경로 계획 중에 차량에 대한 적절한 값이 결정되고 적용됩니다.

  • 경로 계획 중에 0이 아닌 값이 재정의될 수 있습니다. 예를 들어 현재 트래픽 흐름은 시속 60km입니다. 차량 최대 속도를 시속 50km로 설정하면 라우팅 엔진은 현재 상황이므로 60km/시속을 고려합니다. 차량의 최대 속도는 80km/시속으로 제공되지만 현재 교통 흐름은 시속 60km인 경우 라우팅 엔진은 시속 60km를 다시 사용합니다.
vehicleWeight
 query

integer

차량의 무게(킬로그램)입니다.

  • *효율성 매개 변수가 설정된 경우 필수입니다.

  • 소비 모델의 컨텍스트에서 사용할 때는 반드시 양수여야 합니다. 가중치 제한이 고려됩니다.

  • 자세한 소비 모델 지정되지 않고 vehicleWeight 값이 0이 아닌 경우 가중치 제한이 고려됩니다.

  • 다른 모든 경우에서 이 매개 변수는 무시됩니다.

합리적인 값 : 연소 모델 : 1600, 전기 모델 : 1900
vehicleWidth
 query

number (double)

차량 너비(미터)입니다. 값이 0이면 너비 제한이 고려되지 않습니다.
windingness
 query

WindingnessLevel

스릴 넘치는 경로에 대한 회전의 수준. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.

요청 헤더

Name 필수 형식 Description
x-ms-client-id

string

Microsoft Entra ID 보안 모델과 함께 사용할 계정을 나타냅니다. Azure Maps 계정에 대한 이 고유 ID는 Azure Maps 관리 평면 계정 API에서 가져올 수 있습니다. Azure Maps에서 Microsoft Entra ID 보안을 사용하는 방법에 대한 자세한 내용은 Azure Maps에서 인증 관리를 참조하세요.

응답

Name 형식 Description
200 OK

RouteDirections

그래
Other Status Codes

ErrorResponse

예기치 않은 오류가 발생했습니다.

보안

AADToken

다음은 Microsoft Entra OAuth 2.0 흐름에 . Azure 역할 기반 액세스 컨트롤과 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 Azure Maps REST API에 대한 하나 이상의 권한으로 구성된 기본 제공 역할 또는 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.

시나리오를 구현하려면인증 개념을 확인하는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하기 위한 솔루션을 제공합니다.

비고

  • 이 보안 정의 x-ms-client-id 헤더를 사용하여 애플리케이션이 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API가져올 수 있습니다.

Authorization URL Azure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. * Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다. * Azure Maps Web SDK 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

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

subscription-key

Azure Portal에서 Azure Maps 계정 만들거나 PowerShell, CLI, Azure SDK 또는 REST API를 사용할 때 프로비전되는 공유 키입니다.

이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있습니다. 즉, 이 키를 발급된 계정에서 마스터 키로 사용할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 키를 안전하게 저장할 수 있도록 기밀 클라이언트 애플리케이션 접근 방식을 사용하여 Azure Maps REST API에 액세스하는 것이 좋습니다.

형식: apiKey
In(다음 안에): query

SAS Token

공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해 Azure Maps 리소스의 SAS 나열 작업에서 만들어집니다.

이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어를 사용하여 액세스하고 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어 권한을 부여받습니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.

공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 허용된 원본의 특정 목록을 구성하는 것이 좋습니다.

형식: apiKey
In(다음 안에): header

예제

Successfully retrieve a route between an origin and a destination

샘플 요청

GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

샘플 응답

상태 코드:
200 
{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

정의

Name Description
AlternativeRouteType

참조 경로에 비해 계산된 대안의 지정된 계획 기준에 따라 최적도를 제어합니다.
ComputeTravelTime

다양한 유형의 교통 정보(없음, 기록, 라이브)와 기본 최적 예상 이동 시간을 사용하여 추가 이동 시간을 반환할지 여부를 지정합니다.
DelayMagnitude

인시던트로 인한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 세부 정보 가져오기 API 응답 필드 타이의 값에 해당합니다.
DrivingSide

기동 지점에서 왼쪽 및 오른쪽 주행을 나타냅니다.
EffectiveSetting

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

오류 응답
GuidanceInstructionType

명령 유형(예: 도로 형식의 순서 또는 변경)입니다.
GuidanceManeuver

기동을 식별하는 코드입니다.
InclineLevel

스릴 넘치는 경로에 대한 언덕의 정도. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.
JunctionType

기동이 이루어지는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.
LatLongPair

위도 및 경도로 표시되는 위치입니다.
Report

진단을 위해 보고해야 하는 데이터를 지정합니다. 유일한 가능한 값은 effectiveSettings. API를 호출할 때 사용되는 유효 매개 변수 또는 데이터를 보고합니다. 기본 매개 변수의 경우 기본값은 호출자가 매개 변수를 지정하지 않은 위치에 반영됩니다.
ResponseFormat

원하는 응답 형식입니다. 값은 json 또는 xml 수 있습니다.
ResponseSectionType

보고된 경로 응답의 섹션 형식
ResponseTravelMode

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 other 설정됩니다.
Route
RouteAvoidType

경로를 결정할 때 경로 계산에서 피해야 하는 항목을 지정합니다. 한 요청에서 여러 번 지정할 수 있습니다( 예: '&avoid=motorways&avoid=tollRoads&avoid=ferries'). 경로 범위 요청에서 이미UsedRoads 값을 사용하면 안 됩니다.
RouteDirections

이 개체는 성공적인 경로 방향 호출에서 반환됩니다.
RouteGuidance

관련 지침 요소를 포함합니다. 이 필드는 지침이 요청되어 사용할 수 있는 경우에만 존재합니다.
RouteInstruction

기동을 설명하는 특성 집합(예: '오른쪽으로 돌기', '왼쪽 유지', '페리 타기', '고속도로 이용', '도착')
RouteInstructionGroup

서로 관련된 명령 요소의 시퀀스를 그룹화합니다. 시퀀스 범위는 firstInstructionIndex 및 lastInstructionIndex로 제한됩니다. 사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하면 instructionGroup에는 사용 가능한 경우 반환되는 요약 메시지가 있습니다.
RouteInstructionsType

지정한 경우 지침 지침이 반환됩니다. instructionsType 매개 변수는 routeRepresentation=none과 함께 사용할 수 없습니다.
RouteLeg

점 목록으로 구성된 경로의 일부에 대한 설명입니다. 요청에 제공된 각 추가 중간 지점은 반환된 경로에 추가 레그를 생성합니다.
RouteLegSummary

경로 섹션에 대한 요약 개체입니다.
RouteOptimizedWaypoint

최적화된 방법 지점 개체입니다.
RouteReport

현재 호출에 사용된 유효 설정을 보고합니다.
RouteRepresentationForBestOrder

응답으로 제공된 경로 집합의 표현을 지정합니다.
RouteSection

경로 섹션에는 경로의 일부에 대한 추가 정보가 포함되어 있습니다. 각 섹션에는 startPointIndex, endPointIndex및 sectionType요소 이상이 포함되어 있습니다.
RouteSectionTec

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.
RouteSectionTecCause

트래픽 이벤트의 원인입니다. mainCauseCode 및 subCauseCode 요소를 포함할 수 있습니다. 아이콘 및 설명을 정의하는 데 사용할 수 있습니다.
RouteSummary

요약 개체
RouteType

요청된 경로의 유형입니다.
SectionType

경로 응답에서 보고되는 섹션 유형을 지정합니다.

예를 들어 sectionType = 보행자에 적합한 구역만 반환됩니다. 한 요청에서 여러 번 지정할 수 있습니다(예: '§ionType=carTrain§ionType=pedestrian§ionType=motorway'). 기본 sectionType은 travelMode 입력을 참조합니다. 기본적으로 travelMode는 자동차로 설정됩니다.
SimpleCategory

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.
TravelMode

요청된 경로에 대한 이동 모드입니다. 정의되지 않은 경우 기본값은 'car'입니다. 요청된 travelMode를 전체 경로에 사용할 수 없습니다. 요청된 travelMode를 특정 섹션에 사용할 수 없는 경우 해당 섹션에 대한 응답의 travelMode 요소는 "other"가 됩니다. 여행 모드 버스, 오토바이, 택시 및 밴은 BETA 기능입니다. 일부 영역에서는 전체 제한 데이터를 사용할 수 없습니다.
VehicleEngineType

차량의 엔진 유형입니다. 자세한 소비 모델을 지정하면 vehicleEngineType값과 일치해야 합니다.
VehicleLoadType

위험 물질로 분류되고 일부 도로에서 제한될 수 있는 화물 유형입니다. 사용 가능한 vehicleLoadType 값은 미국 Hazmat 클래스 1~9와 다른 국가/지역에서 사용할 일반 분류입니다. USHazmat로 시작하는 값은 미국 라우팅을 위한 것이고 다른 모든 국가/지역에는 otherHazmat을 사용해야 합니다. vehicleLoadType을 여러 번 지정할 수 있습니다. 이 매개 변수는 현재 travelMode=truck에 대해서만 고려됩니다.
WindingnessLevel

스릴 넘치는 경로에 대한 회전의 수준. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.

AlternativeRouteType

열거형

참조 경로에 비해 계산된 대안의 지정된 계획 기준에 따라 최적도를 제어합니다.

값 Description
anyRoute

최적 측면에서 참조 경로와 비교하는 방법에 관계없이 대체 경로를 반환할 수 있습니다.
betterRoute

지정된 계획 조건에 따라 참조 경로보다 더 나은 경우에만 대체 경로를 반환합니다.

ComputeTravelTime

열거형

다양한 유형의 교통 정보(없음, 기록, 라이브)와 기본 최적 예상 이동 시간을 사용하여 추가 이동 시간을 반환할지 여부를 지정합니다.

값 Description
none

추가 이동 시간을 계산하지 않습니다.
all

모든 유형의 트래픽 정보에 대한 이동 시간을 계산하고 경로 응답의 요약에 포함되는 noTrafficTravelTimeInSeconds, historicTrafficTravelTimeInSeconds 및 liveTrafficIncidentsTravelTimeInSeconds 필드에 모든 결과를 지정합니다.

DelayMagnitude

열거형

인시던트로 인한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 세부 정보 가져오기 API 응답 필드 타이의 값에 해당합니다.

값 Description
0

알려지지 않은.
1

사소한.
2

온화한.
3

전공.
4

정의되지 않음, 도로 폐쇄 및 기타 무기한 지연에 사용됩니다.

DrivingSide

열거형

기동 지점에서 왼쪽 및 오른쪽 주행을 나타냅니다.

값 Description
LEFT

왼쪽.
RIGHT

오른쪽.

EffectiveSetting

Object

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

Name 형식 Description
key

string

사용된 매개 변수의 이름입니다.
value

string

사용된 매개 변수의 값입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

GuidanceInstructionType

열거형

명령 유형(예: 도로 형식의 순서 또는 변경)입니다.

값 Description
TURN

돌다.
ROAD_CHANGE

도로 변경.
LOCATION_DEPARTURE

출발 위치입니다.
LOCATION_ARRIVAL

도착 위치입니다.
DIRECTION_INFO

방향 정보입니다.
LOCATION_WAYPOINT

방향 지점 위치입니다.

GuidanceManeuver

열거형

기동을 식별하는 코드입니다.

값 Description
ARRIVE

도착했습니다.
ARRIVE_LEFT

도착했습니다. 대상은 왼쪽에 있습니다.
ARRIVE_RIGHT

도착했습니다. 대상이 오른쪽에 있습니다.
DEPART

떠나다.
STRAIGHT

똑바로 유지합니다.
KEEP_RIGHT

올바르게 유지합니다.
BEAR_RIGHT

오른쪽 곰.
TURN_RIGHT

오른쪽으로 돌립니다.
SHARP_RIGHT

날카로운 오른쪽으로 돌립니다.
KEEP_LEFT

왼쪽으로 유지합니다.
BEAR_LEFT

곰 왼쪽.
TURN_LEFT

좌회전합니다.
SHARP_LEFT

날카로운 왼쪽으로 돌립니다.
MAKE_UTURN

유턴을 합니다.
ENTER_MOTORWAY

고속도로를 타고.
ENTER_FREEWAY

고속도로를 타고.
ENTER_HIGHWAY

고속도로를 타고.
TAKE_EXIT

출구를 가져 가라.
MOTORWAY_EXIT_LEFT

왼쪽 출구를 가져 가라.
MOTORWAY_EXIT_RIGHT

오른쪽 출구를 가져 가라.
TAKE_FERRY

페리를 타고.
ROUNDABOUT_CROSS

로터리를 교차합니다.
ROUNDABOUT_RIGHT

로터리에서 오른쪽의 출구를 가져옵니다.
ROUNDABOUT_LEFT

로터리에서 왼쪽의 출구를 가져옵니다.
ROUNDABOUT_BACK

로터리 주위를 이동합니다.
TRY_MAKE_UTURN

유턴을 시도합니다.
FOLLOW

뒤따르다.
SWITCH_PARALLEL_ROAD

병렬 도로로 전환합니다.
SWITCH_MAIN_ROAD

주요 도로로 전환합니다.
ENTRANCE_RAMP

경사로를 가져 가라.
WAYPOINT_LEFT

당신은 중간 지점에 도달했습니다. 왼쪽에 있습니다.
WAYPOINT_RIGHT

당신은 중간 지점에 도달했습니다. 오른쪽에 있습니다.
WAYPOINT_REACHED

당신은 중간 지점에 도달했습니다.

InclineLevel

열거형

스릴 넘치는 경로에 대한 언덕의 정도. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.

값 Description
low

낮다
normal

노멀
high

높다

JunctionType

열거형

기동이 이루어지는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.

값 Description
REGULAR

일반
ROUNDABOUT

회전목마
BIFURCATION

분기

LatLongPair

Object

위도 및 경도로 표시되는 위치입니다.

Name 형식 Description
latitude

number (double)

위도 속성
longitude

number (double)

경도 속성

Report

열거형

진단을 위해 보고해야 하는 데이터를 지정합니다. 유일한 가능한 값은 effectiveSettings. API를 호출할 때 사용되는 유효 매개 변수 또는 데이터를 보고합니다. 기본 매개 변수의 경우 기본값은 호출자가 매개 변수를 지정하지 않은 위치에 반영됩니다.

값 Description
effectiveSettings

API를 호출할 때 사용되는 유효 매개 변수 또는 데이터를 보고합니다.

ResponseFormat

열거형

원하는 응답 형식입니다. 값은 json 또는 xml 수 있습니다.

값 Description
json

JavaScript 개체 표기법 데이터 교환 형식

xml

확장 가능한 태그 언어

ResponseSectionType

열거형

보고된 경로 응답의 섹션 형식

값 Description
CAR_TRAIN

자동차 또는 기차인 경로의 섹션입니다.
COUNTRY

경로가 있는 국가/지역을 나타내는 섹션입니다.
FERRY

페리인 경로의 섹션입니다.
MOTORWAY

고속도로인 경로의 섹션입니다.
PEDESTRIAN

보행자에게만 적합한 경로의 섹션입니다.
TOLL_ROAD

통행료를 지불해야 하는 경로의 섹션입니다.
TOLL_VIGNETTE

유료 비네팅이 필요한 경로의 섹션입니다.
TRAFFIC

트래픽 정보를 포함하는 경로의 섹션입니다.
TRAVEL_MODE

요청 매개 변수와 관련된 섹션은 travelMode.
TUNNEL

터널인 경로의 섹션입니다.
CARPOOL

카풀(HOV/높은 점유 차량) 차선을 사용해야 하는 경로의 섹션입니다.
URBAN

도시 지역 내에 있는 경로의 섹션입니다.

ResponseTravelMode

열거형

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 other 설정됩니다.

값 Description
car

반환된 경로는 자동차에 최적화되어 있습니다.
truck

반환된 경로는 트럭과 같은 상용 차량에 최적화되어 있습니다.
taxi

반환된 경로는 택시에 최적화되어 있습니다. BETA 기능.
bus

반환된 경로는 버스 전용 차선 사용을 포함하여 버스에 최적화되어 있습니다. BETA 기능.
van

반환된 경로는 밴에 최적화되어 있습니다. BETA 기능.
motorcycle

반환된 경로는 오토바이에 최적화되어 있습니다. BETA 기능.
bicycle

반환된 경로는 자전거 차선 사용을 포함하여 자전거에 최적화되어 있습니다.
pedestrian

반환된 경로는 보도 사용을 포함하여 보행자에 최적화되어 있습니다.
other

이 섹션에서는 지정된 전송 모드를 사용할 수 없습니다.

Route

Object
Name 형식 Description
guidance

RouteGuidance

관련 지침 요소를 포함합니다. 이 필드는 지침이 요청되어 사용할 수 있는 경우에만 존재합니다.
legs

RouteLeg[]

다리 배열
sections

RouteSection[]

섹션 배열
summary

RouteSummary

요약 개체

RouteAvoidType

열거형

경로를 결정할 때 경로 계산에서 피해야 하는 항목을 지정합니다. 한 요청에서 여러 번 지정할 수 있습니다( 예: '&avoid=motorways&avoid=tollRoads&avoid=ferries'). 경로 범위 요청에서 이미UsedRoads 값을 사용하면 안 됩니다.

값 Description
tollRoads

유료 도로를 방지합니다.
motorways

고속도로 방지
ferries

페리 방지
unpavedRoads

비포장 도로 방지
carpools

카풀(HOV/높은 점유 차량) 차선을 사용해야 하는 경로를 방지합니다.
alreadyUsedRoads

동일한 도로를 여러 번 사용하지 않습니다. routeType=thrilling과 함께 가장 유용합니다.
borderCrossings

경로 계산에서 테두리 횡단을 방지합니다.

RouteDirections

Object

이 개체는 성공적인 경로 방향 호출에서 반환됩니다.

Name 형식 Description
formatVersion

string

Format Version 속성
optimizedWaypoints

RouteOptimizedWaypoint[]

최적화된 웨이포인트 시퀀스입니다. 원래 및 최적화된 목록에 대해 사용자가 제공한 웨이포인트 시퀀스의 인덱스를 보여줍니다. 예를 들어 응답은 다음과 같습니다.

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

는 원래 시퀀스가 [0, 1, 2]이고 최적화된 시퀀스가 [1, 2, 0]임을 의미합니다. 인덱스가 0부터 시작되므로 원래는 "첫 번째, 두 번째, 세 번째"이고 최적화는 "두 번째, 세 번째, 첫 번째"입니다.
report

RouteReport

현재 호출에 사용된 유효 설정을 보고합니다.
routes

Route[]

경로 배열

RouteGuidance

Object

관련 지침 요소를 포함합니다. 이 필드는 지침이 요청되어 사용할 수 있는 경우에만 존재합니다.

Name 형식 Description
instructionGroups

RouteInstructionGroup[]

서로 관련된 명령 요소의 시퀀스를 그룹화합니다.
instructions

RouteInstruction[]

기동을 설명하는 지침 목록입니다.

RouteInstruction

Object

기동을 설명하는 특성 집합(예: '오른쪽으로 돌기', '왼쪽 유지', '페리 타기', '고속도로 이용', '도착')

Name 형식 Description
combinedMessage

string

다음 명령의 메시지와 결합된 기동에 대한 사람이 읽을 수 있는 메시지입니다. 경우에 따라 두 개의 연속 명령을 단일 명령으로 결합하여 더 쉽게 따를 수 있습니다. 이 경우 가능한CombineWithNext 플래그가 true가 됩니다. 다음은 그 예입니다.

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

명령 10의 가능한CombineWithNext 플래그는 true입니다. 이는 코딩된 지침의 클라이언트에게 명령 11과 결합할 수 있음을 나타냅니다. 이 지침은 사람이 읽을 수 있는 지침을 요청하는 클라이언트에 대해 자동으로 결합됩니다. combinedMessage 필드에는 결합된 메시지가 포함됩니다.

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3자 ISO 3166-1 alpha-3 국가 코드입니다. 예: 미국
drivingSide

DrivingSide

기동 지점에서 왼쪽 및 오른쪽 주행을 나타냅니다.
exitNumber

string

현재 기동에서 가져온 고속도로 출구의 번호입니다. 출구에 여러 개의 종료 번호가 있는 경우 ""로 구분되고 "-"(예: "10, 13-15")로 집계될 수 있습니다.
instructionType

GuidanceInstructionType

명령 유형(예: 도로 형식의 순서 또는 변경)입니다.
junctionType

JunctionType

기동이 이루어지는 접합의 유형입니다. 더 큰 로터리인 경우 로터리에 들어가고 나가는 두 개의 별도 명령이 생성됩니다.
maneuver

GuidanceManeuver

기동을 식별하는 코드입니다.
message

string

기동을 위해 사람이 읽을 수 있는 메시지입니다.
point

LatLongPair

위도 및 경도로 표시되는 위치입니다.
pointIndex

integer

명령의 지점에 해당하는 폴리라인 "points" 목록에 있는 점의 인덱스입니다.
possibleCombineWithNext

boolean

필요에 따라 명령을 다음 명령과 결합할 수 있습니다. "왼쪽으로 돌고 오른쪽으로 돌립니다"와 같은 메시지를 작성하는 데 사용할 수 있습니다.
roadNumbers

string[]

기동 후의 다음 중요한 도로 세그먼트 또는 따라야 할 도로의 도로 번호입니다. 예: ["E34", "N205"]
roundaboutExitNumber

integer (int64)

이는 로터리에서 수행할 종료를 나타냅니다.
routeOffsetInMeters

integer

경로 시작부터 명령 지점까지의 거리입니다.
signpostText

string

기동 또는 따라야 하는 방향과 가장 관련이 있는 표지판의 텍스트입니다.
stateCode

string

ISO 3166-2 코드의 두 번째 부분으로 표현되는 국가의 세분화(예: 상태)입니다. 이는 미국, 캐나다 및 멕시코와 같은 일부 국가/지역에서만 사용할 수 있습니다.
street

string

기동 후 다음 중요한 도로 세그먼트의 거리 이름, 또는 따라야 할 거리의 이름입니다.
travelTimeInSeconds

integer

routeOffsetInMeters에 해당하는 지점까지의 예상 이동 시간입니다.
turnAngleInDecimalDegrees

integer

명령의 방향을 나타냅니다. junctionType이 턴 명령을 나타내는 경우:

  • 180 = 유턴
  • [-179, -1] = 좌회전
  • 0 = 직선 켜기('0도' 회전)
  • [1, 179] = 오른쪽 회전

junctionType이 분기 명령을 나타내는 경우:

  • <0 - 왼쪽 유지
  • >0 - 오른쪽 유지

RouteInstructionGroup

Object

서로 관련된 명령 요소의 시퀀스를 그룹화합니다. 시퀀스 범위는 firstInstructionIndex 및 lastInstructionIndex로 제한됩니다. 사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하면 instructionGroup에는 사용 가능한 경우 반환되는 요약 메시지가 있습니다.

Name 형식 Description
firstInstructionIndex

integer

이 그룹에 속하는 지침의 첫 번째 명령 인덱스입니다.
groupLengthInMeters

integer

그룹의 길이입니다.
groupMessage

string

사람이 읽을 수 있는 문자 메시지가 지침(instructionType=text 또는 태그 지정)을 요청하는 경우의 요약 메시지입니다.
lastInstructionIndex

integer

이 그룹에 속하는 지침의 마지막 명령 인덱스입니다.

RouteInstructionsType

열거형

지정한 경우 지침 지침이 반환됩니다. instructionsType 매개 변수는 routeRepresentation=none과 함께 사용할 수 없습니다.

값 Description
coded

사람이 읽을 수 있는 메시지 없이 원시 명령 데이터를 반환합니다.
text

사람이 읽을 수 있는 메시지를 일반 텍스트로 사용하여 원시 명령 데이터를 반환합니다.
tagged

사람이 읽을 수 있는 메시지에 태그가 지정된 원시 명령 데이터를 반환하여 서식을 허용합니다. 사람이 읽을 수 있는 메시지는 반복 가능한 식별 요소에서 빌드됩니다. 이러한 태그는 클라이언트 애플리케이션이 올바르게 형식을 지정할 수 있도록 태그가 지정됩니다. instructionsType=태그가 지정된 경우 다음 메시지 구성 요소에 태그가 지정됩니다. street, roadNumber, signpostText, exitNumber, roundaboutExitNumber.

태그가 지정된 '좌회전' 메시지의 예:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>

RouteLeg

Object

점 목록으로 구성된 경로의 일부에 대한 설명입니다. 요청에 제공된 각 추가 중간 지점은 반환된 경로에 추가 레그를 생성합니다.

Name 형식 Description
points

LatLongPair[]

점 배열
summary

RouteLegSummary

경로 섹션에 대한 요약 개체입니다.

RouteLegSummary

Object

경로 섹션에 대한 요약 개체입니다.

Name 형식 Description
arrivalTime

string (date-time)

경로 또는 다리의 예상 도착 시간입니다. 시간은 UTC입니다.
batteryConsumptionInkWh

number (double)

전기 소비 모델을 사용하는 킬로와트시(kWh)의 예상 전기 에너지 소비량입니다. vehicleEngineType이 전기로 설정되고 constantSpeedConsumptionInkWhPerHundredkm가 지정된 경우 포함됩니다. batteryConsumptionInkWh의 값은 회복된 전기 에너지를 포함하므로 음수일 수 있습니다(에너지 확보를 나타낸다). maxChargeInkWh와 currentChargeInkWh를 모두 지정하면 배터리 충전 수준이 maxChargeInkWh를 초과하지 않도록 회수가 제한됩니다. maxChargeInkWh와 currentChargeInkWh를 모두 지정하지 않으면 소비 계산에서 제한되지 않은 회복이 가정됩니다.
departureTime

string (date-time)

경로 또는 다리의 예상 출발 시간입니다. 시간은 UTC입니다.
fuelConsumptionInLiters

number (double)

연소 소비 모델을 사용하는 리터의 예상 연료 소비량입니다. vehicleEngineType이 연소 설정되고 constantSpeedConsumptionInLitersPerHundredkm가 지정된 경우 포함됩니다. 값은 음수가 아닌 값입니다.
historicTrafficTravelTimeInSeconds

integer

시간 종속 기록 트래픽 데이터를 사용하여 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모두 쿼리에 사용되는 경우에만 포함됩니다.
lengthInMeters

integer

Length In Meters 속성
liveTrafficIncidentsTravelTimeInSeconds

integer

실시간 속도 데이터를 사용하여 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모두 쿼리에 사용되는 경우에만 포함됩니다.
noTrafficTravelTimeInSeconds

integer

교통 상황(예: 혼잡)으로 인해 경로에 지연이 없는 것처럼 계산된 예상 이동 시간입니다. computeTravelTimeFor = 모두 쿼리에 사용되는 경우에만 포함됩니다.
trafficDelayInSeconds

integer

트래픽 정보에 따른 실시간 인시던트로 인한 예상 지연 시간(초)입니다. 향후 출발 시간으로 계획된 경로의 경우 지연은 항상 0입니다. 다양한 유형의 트래픽 정보를 사용하여 추가 이동 시간을 반환하려면 computeTravelTimeFor=all 매개 변수를 추가해야 합니다.
travelTimeInSeconds

integer

실시간 트래픽으로 인한 지연을 포함하는 예상 이동 시간(초) 속성입니다. traffic=false travelTimeInSeconds에도 트래픽으로 인한 지연이 계속 포함됩니다. DepartAt가 향후인 경우 이동 시간은 시간 종속 기록 트래픽 데이터를 사용하여 계산됩니다.

RouteOptimizedWaypoint

Object

최적화된 방법 지점 개체입니다.

Name 형식 Description
optimizedIndex

integer

시스템에서 최적화된 점 인덱스입니다.
providedIndex

integer

사용자가 제공하는 방법 지점 인덱스입니다.

RouteReport

Object

현재 호출에 사용된 유효 설정을 보고합니다.

Name 형식 Description
effectiveSettings

EffectiveSetting[]

이 Route API를 호출할 때 사용되는 유효 매개 변수 또는 데이터입니다.

RouteRepresentationForBestOrder

열거형

응답으로 제공된 경로 집합의 표현을 지정합니다.

값 Description
polyline

응답에 경로 기하 도형을 포함합니다.
summaryOnly

응답의 경로에 대한 점 기하 도형 요소를 제외한 폴리라인별 요약입니다.
none

최적화된 웨이포인트 인덱스만 포함하지만 응답에 경로 기하 도형은 포함되지 않습니다. 이 매개 변수 값은 computeBestOrder=true와 함께만 사용할 수 있습니다.

RouteSection

Object

경로 섹션에는 경로의 일부에 대한 추가 정보가 포함되어 있습니다. 각 섹션에는 startPointIndex, endPointIndex및 sectionType요소 이상이 포함되어 있습니다.

Name 형식 Description
delayInSeconds

integer

인시던트로 인한 지연 시간(초)입니다.
effectiveSpeedInKmh

integer

인시던트 유효 속도(km/h)는 전체 길이에서 평균을 초과했습니다.
endPointIndex

integer

이 섹션이 적용되는 경로의 마지막 점(오프셋 0)의 인덱스입니다.
magnitudeOfDelay

DelayMagnitude

인시던트로 인한 지연의 크기입니다. 이러한 값은 트래픽 인시던트 세부 정보 가져오기 API 응답 필드 타이의 값에 해당합니다.
sectionType

ResponseSectionType

보고된 경로 응답의 섹션 형식
simpleCategory

SimpleCategory

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.
startPointIndex

integer

이 섹션이 적용되는 경로의 첫 번째 점(오프셋 0)의 인덱스입니다.
tec

RouteSectionTec

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.
travelMode

ResponseTravelMode

계산된 경로의 이동 모드입니다. 이 섹션에서 요청된 전송 모드를 사용할 수 없는 경우 값이 other 설정됩니다.

RouteSectionTec

Object

TPEG2-TEC 표준의 정의를 사용하여 트래픽 이벤트에 대한 세부 정보입니다. effectCode를 포함할 수 있으며 요소를 발생합니다.

Name 형식 Description
causes

RouteSectionTecCause[]

배열의 원인
effectCode

integer

트래픽 흐름에 미치는 영향입니다. TPEG2-TEC 표준에 정의된 대로 tec001:EffectCode 테이블에 값을 포함합니다. 심각도에 따라 트래픽 이벤트를 색으로 지정하는 데 사용할 수 있습니다.

RouteSectionTecCause

Object

트래픽 이벤트의 원인입니다. mainCauseCode 및 subCauseCode 요소를 포함할 수 있습니다. 아이콘 및 설명을 정의하는 데 사용할 수 있습니다.

Name 형식 Description
mainCauseCode

integer

트래픽 이벤트의 주요 원인입니다. TPEG2-TEC 표준에 정의된 대로 tec002:CauseCode 테이블에 값을 포함합니다.
subCauseCode

integer

트래픽 이벤트의 하위 이벤트입니다. TPEG2-TEC 표준에 정의된 대로 mainCauseCode에 정의된 하위 원인 테이블의 값을 포함합니다.

RouteSummary

Object

요약 개체

Name 형식 Description
arrivalTime

string (date-time)

경로 또는 다리의 예상 도착 시간입니다. 시간은 UTC입니다.
departureTime

string (date-time)

경로 또는 다리의 예상 출발 시간입니다. 시간은 UTC입니다.
lengthInMeters

integer

Length In Meters 속성
trafficDelayInSeconds

integer

트래픽 정보에 따른 실시간 인시던트로 인한 예상 지연 시간(초)입니다. 향후 출발 시간으로 계획된 경로의 경우 지연은 항상 0입니다. 다양한 유형의 트래픽 정보를 사용하여 추가 이동 시간을 반환하려면 computeTravelTimeFor=all 매개 변수를 추가해야 합니다.
travelTimeInSeconds

integer

실시간 트래픽으로 인한 지연을 포함하는 예상 이동 시간(초) 속성입니다. traffic=false travelTimeInSeconds에도 트래픽으로 인한 지연이 계속 포함됩니다. DepartAt가 향후인 경우 이동 시간은 시간 종속 기록 트래픽 데이터를 사용하여 계산됩니다.

RouteType

열거형

요청된 경로의 유형입니다.

값 Description
fastest

가장 빠른 경로입니다.
shortest

거리별 최단 경로입니다.
eco

경제와 속도에 의해 균형 잡힌 경로입니다.
thrilling

흥미롭거나 까다로운 도로를 포함하며 가능한 한 적은 수의 고속도로를 사용합니다. 포함된 턴 수준과 구불구불한 정도를 선택할 수 있습니다. 이를 설정하는 방법은 구불구불한 구불구불한 구불구불한 매개 변수를 참조하세요. routeType=thrilling으로 계획된 경로에는 900km의 제한이 있습니다.

SectionType

열거형

경로 응답에서 보고되는 섹션 유형을 지정합니다.

예를 들어 sectionType = 보행자에 적합한 구역만 반환됩니다. 한 요청에서 여러 번 지정할 수 있습니다(예: '§ionType=carTrain§ionType=pedestrian§ionType=motorway'). 기본 sectionType은 travelMode 입력을 참조합니다. 기본적으로 travelMode는 자동차로 설정됩니다.

값 Description
carTrain

자동차 또는 기차인 경로의 섹션입니다.
country

경로가 있는 국가/지역을 나타내는 섹션입니다.
ferry

페리인 경로의 섹션입니다.
motorway

고속도로인 경로의 섹션입니다.
pedestrian

보행자에게만 적합한 경로의 섹션입니다.
tollRoad

통행료를 지불해야 하는 경로의 섹션입니다.
tollVignette

유료 비네팅이 필요한 경로의 섹션입니다.
traffic

트래픽 정보를 포함하는 경로의 섹션입니다.
travelMode

요청 매개 변수와 관련된 섹션은 travelMode.
tunnel

터널인 경로의 섹션입니다.
carpool

카풀(HOV/높은 점유 차량) 차선을 사용해야 하는 경로의 섹션입니다.
urban

도시 지역 내에 있는 경로의 섹션입니다.

SimpleCategory

열거형

인시던트 유형입니다. 현재 JAM, ROAD_WORK, ROAD_CLOSURE 또는 기타일 수 있습니다. 자세한 내용은 "tec"을 참조하세요.

값 Description
JAM

교통 체증.
ROAD_WORK

도로 작업.
ROAD_CLOSURE

도로 폐쇄.
OTHER

기타

TravelMode

열거형

요청된 경로에 대한 이동 모드입니다. 정의되지 않은 경우 기본값은 'car'입니다. 요청된 travelMode를 전체 경로에 사용할 수 없습니다. 요청된 travelMode를 특정 섹션에 사용할 수 없는 경우 해당 섹션에 대한 응답의 travelMode 요소는 "other"가 됩니다. 여행 모드 버스, 오토바이, 택시 및 밴은 BETA 기능입니다. 일부 영역에서는 전체 제한 데이터를 사용할 수 없습니다.

값 Description
car

반환된 경로는 자동차에 최적화되어 있습니다.
truck

반환된 경로는 트럭과 같은 상용 차량에 최적화되어 있습니다.
taxi

반환된 경로는 택시에 최적화되어 있습니다. BETA 기능.
bus

반환된 경로는 버스 전용 차선 사용을 포함하여 버스에 최적화되어 있습니다. BETA 기능.
van

반환된 경로는 밴에 최적화되어 있습니다. BETA 기능.
motorcycle

반환된 경로는 오토바이에 최적화되어 있습니다. BETA 기능.
bicycle

반환된 경로는 자전거 차선 사용을 포함하여 자전거에 최적화되어 있습니다.
pedestrian

반환된 경로는 보도 사용을 포함하여 보행자에 최적화되어 있습니다.

VehicleEngineType

열거형

차량의 엔진 유형입니다. 자세한 소비 모델을 지정하면 vehicleEngineType값과 일치해야 합니다.

값 Description
combustion

내부 연소 엔진.
electric

전기 엔진.

VehicleLoadType

열거형

위험 물질로 분류되고 일부 도로에서 제한될 수 있는 화물 유형입니다. 사용 가능한 vehicleLoadType 값은 미국 Hazmat 클래스 1~9와 다른 국가/지역에서 사용할 일반 분류입니다. USHazmat로 시작하는 값은 미국 라우팅을 위한 것이고 다른 모든 국가/지역에는 otherHazmat을 사용해야 합니다. vehicleLoadType을 여러 번 지정할 수 있습니다. 이 매개 변수는 현재 travelMode=truck에 대해서만 고려됩니다.

값 Description
USHazmatClass1

폭발물
USHazmatClass2

압축 가스
USHazmatClass3

인화성 액체
USHazmatClass4

인화성 고형물
USHazmatClass5

산화제
USHazmatClass6

독극물
USHazmatClass7

방사성
USHazmatClass8

부식성
USHazmatClass9

기타
otherHazmatExplosive

폭발물
otherHazmatGeneral

기타
otherHazmatHarmfulToWater

물에 유해

WindingnessLevel

열거형

스릴 넘치는 경로에 대한 회전의 수준. 이 매개 변수는 routeType=thrilling과 함께만 사용할 수 있습니다.

값 Description
low

낮다
normal

노멀
high

높다