driving

概要

道探し APIは、地図アプリのメイン画面から主な地域までの所要時間と距離、予想燃料費、通行料金情報を提供します。
そして経路上のジャンクションで案内が必要な場合、当該地点での guide codeを提供します。

リクエスト

curl "https://naveropenapi.apigw.ntruss.com/map-direction-15/v1/driving?start={出発地}&goal={目的地}&option={探索オプション}" \
	-H "X-NCP-APIGW-API-KEY-ID: {アプリケーション登録時に発行された client id値}" \
	-H "X-NCP-APIGW-API-KEY: {アプリケーション登録時に発行された client secret値}" -v

リクエストパラメータ

道探し APIのクエリ文字列パラメータに共通して当てはまる内容です。

• 別途情報がなければ距離単位は meter、時間単位は millisecond(1/1000秒)を使用します。
• 文字列エンコーディングは UTF-8を使用します。

Request Position Format

必須項目(経度、緯度)とオプション項目(名称、地点 ID)を , 文字で連結した文字列です。

• オプション項目は項目に合った prefixが必要です。
• オプション項目の値は ,、 : または | 文字を含むことはできません。
• 数字でない文字は URLエンコーディングが必要です。
• オプション項目の間の順番を守る必要はありません。

次は request position formatの使用例です。

• 基本例: 127.12345,37.12345
• 名称オプション項目を追加した例: 127.12345,37.12345,name=출발지이름

Multiple Request Position Format

request position format複数を : 文字で連結した文字列です。

• waypointsの各項目は独立的な経由地であり nameを使用したいくつかの request position formatを使用することができます。
  • waypoints 例 1: 127.12345,37.12345:128.12345,38.12345
  • waypoints 例 2: 127.12345,37.12345:128.12345,38.12345,name=장소이름1
  • waypoints 例 3: 127.12345,37.12345,name=장소이름1:128.12345,38.12345,name=장소이름2

Multiple Request Position Format list

multiple request position format複数個を | 文字で連結したリスト文字列です。経由地パラメータである waypointsはこの形式を使用します。

• 経由地が2つあり、各経由地に座標が2つずつある場合の例: 127.12345,37.12345:127.23456,37.23456|128.12345,38.12345:128.23456,38.23456

Cartype Code

料金所の料金計算用の車種情報を表示するコードです。

Fueltype Code

燃料費計算用の燃料種類を表示するコードです。

Option Code

探索オプションを表示するコードです。(すべての経路は交通情報を反映するため、出発地、目的地、オプションが同一であっても同じ経路ではありません)。

Language Code

サポートされる言語の種類を示すコードです。

リクエストヘッダ

リクエストボディ

• 該当 APIはリクエストボディが不要です。

レスポンス

レスポンスボディ

下位構造体は Objectで表現し、rout内の各項目のプロパティは一般的な key-valueペア("key": "value")で表現します。

Route Unit Ent

経路案内のためのプロパティの大分類を表示します。

Summary

探索された経路の要約情報を表示します。

Section Unit

探索された経路の中で、主要道路の情報を表示します。道路名を基準に走行距離が長い経路の情報です。

Guide Unit for Ent

回転案内が必要な地点と回転案内までの距離情報を提供します。

Result Code

ResultCodeが 0でない場合、探索失敗です。

lng-lat Position Format

経度、緯度で構成された座標情報を表示します。Length 2である1次元配列であり、経度、緯度の順番で提供します。(lng, lat).

例: [127.001122, 37.001122]

Response Position Format

出発地、到着地、経由地の座標情報を提供します。

View Direction Code

経路上の目的地/経由地から実際の目的地/経由地に指定した地点の方向を表示します。経路上の進行方向を中心に方向を指定します。

Guide Code

経路上の回転が発生したり、追加案内が必要な地点でどのように進行するかをご案内します。

Congestion code

道路の種別および実際の通行速度情報を利用し推定した混雑度の分類コードです。

次は混雑度を基準に道路種別通行速度を示した表です。

例

リクエスト例

curl "https://naveropenapi.apigw.ntruss.com/map-direction-15/v1/driving?start=127.1058342,37.359708&goal=129.075986,35.179470&option=trafast"\
	-H "X-NCP-APIGW-API-KEY-ID: {アプリケーション登録時に発行された client id値}" \
	-H "X-NCP-APIGW-API-KEY: {アプリケーション登録時に発行された client secret値}" -v

レスポンス例

{
    "code": 0,
    "message": "道探しに成功しました。",
    "currentDateTime": "2018-12-21T14:45:34",
    "route": {
        "trafast": [
            {
                "summary": {
                    "start": {
                        "location": [
                            127.1058342,
                            37.3597078
                        ]
                    },
                    "goal": {
                        "location": [
                            129.0759853,
                            35.1794697
                        ],
                        "dir": 2
                    },
                    "distance": 382403,
                    "duration": 15372873,
                    "bbox": [
                        [
                            127.0833901,
                            35.1793188
                        ],
                        [
                            129.0817364,
                            37.3599059
                        ]
                    ],
                    "tollFare": 24500,
                    "taxiFare": 319900,
                    "fuelPrice": 46027
                },
                "path": [
                    [
                        127.1059968,
                        37.3597093
                    ],

                    ....

                    [
                        129.0764276,
                        35.1795108
                    ],
                    [
                        129.0762855,
                        35.1793188
                    ]
                ],
                "section": [
                    {
                        "pointIndex": 654,
                        "pointCount": 358,
                        "distance": 22495,
                        "name": "ジュクヤン大路",
                        "congestion": 1,
                        "speed": 60
                    },
                    {
                        "pointIndex": 3059,
                        "pointCount": 565,
                        "distance": 59030,
                        "name": "ナクドン大路",
                        "congestion": 1,
                        "speed": 89
                    },
                    {
                        "pointIndex": 4708,
                        "pointCount": 433,
                        "distance": 23385,
                        "name": "セマウル路",
                        "congestion": 1,
                        "speed": 66
                    }
                ],
                "guide": [
                    {
                        "pointIndex": 1,
                        "type": 3,
                        "instructions": "ジョンジャ1路1交差点で「ソンナム大路」方面に右折",
                        "distance": 21,
                        "duration": 4725
                    },
                    {
                        "pointIndex": 8,
                        "type": 3,
                        "instructions": "ブルジョン橋交差点で「スウォン・ヨンイン、ミグム駅」方面に右折",
                        "distance": 186,
                        "duration": 42914
                    },

 					....

                    {
                        "pointIndex": 6824,
                        "type": 14,
                        "instructions": "ヨンサン交差点で「ソミョン交差点,市庁・警察庁」方面に右側1時方向",
                        "distance": 910,
                        "duration": 125240
                    },
                    {
                        "pointIndex": 6842,
                        "type": 88,
                        "instructions": "目的地",
                        "distance": 895,
                        "duration": 111333
                    }
                ]
            }
        ]
    }
}