ナビゲーション（車）
/webnavi/car [GET]
基本情報
概要
自動車を移動手段として、目的地までの経路を案内する Web コンテンツ (HTML, JavaScript, CSS) を取得します。
※当APIをご利用の場合は、ナビゲーション利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/webnavi/car
※APIマーケットでは提供しておりません
出力形式
- HTML
- JavaScript
- CSS
対応言語
- ja
案内可能なルートについて
当 API では、1 対 1 ルートのみ案内が可能です。
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start | ✔ | 出発地点 | カンマ区切りの数値（緯度,経度） | 緯度経度の指定例：35.689457,139.691935（東京都庁） | ||
| goal | ✔ | 到着地点 | カンマ区切りの数値（緯度,経度） | 緯度経度の指定例：35.689457,139.691935（東京都庁） | ||
| start_time | (✔) | 出発時刻 | 文字列（日付時刻） YYYY-MM-DDThh:mm:ss |
時刻の指定例：2019-10-01T08:00:00 goal_timeとの併用は不可（どちらか片方を必ず指定） |
||
| goal_time | (✔) | 到着時刻 | 文字列（日付時刻） YYYY-MM-DDThh:mm:ss |
時刻の指定例：2019-10-01T08:00:00 start_timeとの併用は不可（どちらか片方を必ず指定） |
||
| via | 経由地 | 地点のJSON表現 （配列） |
経由地指定の上限数：10地点 | |||
| via_type | 経由地巡回モード | 文字列 | specified | specified: 指定順 optimal: 最適順 |
指定した経由地をどのように巡回するかを指定します | |
| condition | 経路検索条件 | 文字列 | recommend | recommend：推奨 toll_time：有料道路優先、時間優先 toll_distance：有料道路優先、距離優先 toll_gas：有料道路優先、ガソリン節約優先 free_time：無料道路優先、時間優先 free_distance：無料道路優先、距離優先 free_gas：無料道路優先、ガソリン節約優先 free_only：無料道路利用 |
||
| regulation | 規制に関する車体情報 | JSON表現 | JSON表現の詳細はこちらをご覧ください ※大型車の規制情報利用は、オプション機能のため、別途契約が必要となります |
|||
| smart_ic | スマートIC考慮 | 文字列 | unuse | unuse : スマートICを考慮しない use : スマートICを考慮する |
||
| ferry | フェリー優先検索 | 文字列 | use | unuse : フェリーを使わない use : フェリーを使う more_use : フェリーを優先して使う |
||
| spec_id | (✔) | ユーザー識別子 | 文字列 | 1文字以上50文字以内 | 当APIを使用する場合はリクエストヘッダー「x-ntj-spec-id」、または、パラメータ「spec_id」を必ず設定してください リクエストヘッダー「x-ntj-spec-id」を指定する場合は「spec_id」の指定は不要です |
|
| mode | 経路案内モード | 文字列 | normal | normal：GPS測位モード simulation：シミュレーションモード |
||
| palette | 地図パレット | 文字列 | default | default：デフォルト地図 navigation：ナビゲーション向け地図 |
||
| notice_url | 目的地到着時に通知を行うURL | 文字列 | ||||
| host | ✔ | サイトのドメイン | 文字列 | |||
| platform | プラットフォーム | 文字列 | browser | browser : ブラウザで利用 app: アプリケーションで利用 |
当APIを動かす環境を指定します |
緯度経度の測地系について
当 API では、「世界測地系」のみご利用頂けます。
緯度経度の表記について
当 API では、「度表記」のみご利用頂けます。
経路検索条件の無料道路利用の注意点について
無料道路利用は無料道路優先より高い優先度で検索する経路検索条件です。
パラメータの組み合わせによって、一部経路結果に有料道路が含まれる場合がありますのでご了承ください。
地図パレットについて
ナビゲーション向け地図を指定すると、時刻に応じて自動で昼用の地図と夜用の地図を切り替えます。
当 API の挙動として、案内を開始する前にルート検索を行います。
/route_car のルート検索結果と出力を合わせる場合は、ルート検索時と同じ検索条件（パラメータの設定）でリクエストしてください。
地点の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| lat | ✔ | 緯度 | 数値 | ||
| lon | ✔ | 経度 | 数値 |
経由地の指定方法について
経由地の数だけ地点のJSON表現を配列にして記述します。経由地が1点の場合でも配列表現が必要です。
経由地が1点の場合の記述例は以下の通りです。
via=[{"lat":35.706822,"lon":139.813956}]
最適順ルートを求める場合、経由地は2地点以上登録する必要があります。
経由地指定の上限数は、指定順ルート/最適順ルートどちらとも10地点です。出発地点、到着地点は含みません。
上限数を超える経由地を指定するとエラーとなります。
regulation の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| regulation-type | 車両区分 | 文字列 | 以下のいずれかより1つ指定します standard_passenger :普通乗用自動車 medium_passenger :中型乗用自動車 specific_medium_passenger :特定中型乗用自動車 large_passenger :大型乗用自動車 standard_truck :普通貨物自動車 medium_truck :中型貨物自動車 specific_medium_truck :特定中型貨物自動車 large_truck :大型貨物自動車 large_special_vehicle :大型特殊自動車 small_special_vehicle :小型特殊自動車 light_vehicle :軽自動車 semimedium_passenger :準中型乗用自動車 semimedium_truck :準中型貨物自動車 |
||
| toll-type | 料金車種区分 | 文字列 | 以下のいずれかより1つ指定します small :軽自動車等 standard :普通車 medium :中型車 large :大型車 extra_large :特大車 |
||
| dangerous-goods | 危険物積載車両通行規制考慮 | 文字列 | use：考慮する | ||
| car-body | 車体情報 | JSON表現 |
car-body の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| height | 車の高さ(単位：cm) | 数値 | |||
| width | 車の幅(単位：cm) | 数値 | |||
| length | 車の長さ(単位：cm) | 数値 | |||
| weight | 車の重量(単位：kg) | 数値 | |||
| max-loading-capacity | 車の最大積載量(単位：kg) | 数値 |
JSON 表現は URL エンコードをした上でリクエストしてください。
regulation、car-bodyのJSON表現について
入力された項目のみ考慮しますので、すべての項目を指定する必要はありません
規制に関する車体情報の用途について
regulation-type：通行止め、指定方向外通行禁止などの道路規制の対象となる車両区分を指定します
toll-type：スマートICで通行可否を考慮する場合の料金車種区分を指定します
dangerous-goods：危険物積載車両通行規制道路を通行できるかどうかを判定するために使用します
car-body：車両の大きさや重量により対象道路を通行できるかどうかを判定するために使用します
regulationのJSON表現例
・規制種別：大型貨物自動車, 料金車種：大型自動車, 車長：1200cm, 車高：320cm, 車幅：250cm,重量：24860kg, 最大積載量：15300kg
{
"regulation-type": "large_truck",
"toll-type": "large",
"car-body": {
"length": 1200,
"height": 320,
"width": 250,
"weight": 24860,
"max-loading-capacity": 15300
}
}
パラメータ構成例
・出発地：東京都庁、目的地：東京スカイツリー、出発時刻：2021年3月1日10時のルートをGPS測位モードで案内
/webnavi/car?start=35.689457,139.691935&goal=35.7100578,139.8107308&start_time=2021-03-01T10:00&spec_id=id001&host=localhost
・出発地：東京都庁、目的地：東京スカイツリー、出発時刻：2021年3月1日10時のルートをシミュレーションモードで案内
/webnavi/car?start=35.689457,139.691935&goal=35.7100578,139.8107308&start_time=2021-03-01T10:00&spec_id=id001&host=localhost&mode=simulation
動作環境について
当 API の動作環境は次のとおりです。
iOS/Android アプリ (webviewアプリ)
【対応OS】
- iOS, iPadOS : 13 以上
- Android : 8 以上
Webアプリ
【ブラウザ】
- Safari 最新バージョン
- Google Chrome 最新バージョン
ブラウザで利用する際の注意事項
- 自動的に画面がスリープ状態にならないように "NoSleep" というファイルが再生されます
- ブラウザの仕様変更により画面がスリープ状態になってしまう可能性があります
- iframe での利用は動作保証外となります
共通要件
端末機能「GPS・位置情報サービス」を使用します。