ナビゲーション（自転車）
/webnavi/bicycle [GET]
基本情報
概要
自転車を移動手段として、目的地までの経路を案内する Web コンテンツ (HTML, JavaScript, CSS) を取得します。
※当APIをご利用の場合は、ナビゲーション利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/webnavi/bicycle
※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: 最適順 |
指定した経由地をどのように巡回するかを指定します | |
| speed | 自転車の速度(単位：km/h) | 整数値 | 15 | 最小値：5 最大値：132 |
自転車の速度を設定する場合は整数で時速を指定してください | |
| condition | 自転車ルート検索の優先考慮事項 | 文字列 | recommend | recommend：推奨ルート total_distance：総距離が短い low_pitched：坂道が少ない high_pitched：坂道が多い main_street：大通り優先 back_street：裏通り優先 cycling_road：サイクリングロード優先 |
||
| 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_bicycle のルート検索結果と出力を合わせる場合は、ルート検索時と同じ検索条件（パラメータの設定）でリクエストしてください。
地点の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| lat | ✔ | 緯度 | 数値 | ||
| lon | ✔ | 経度 | 数値 |
経由地の指定方法について
経由地の数だけ地点のJSON表現を配列にして記述します。経由地が1点の場合でも配列表現が必要です。
経由地が1点の場合の記述例は以下の通りです。
via=[{"lat":35.706822,"lon":139.813956}]
最適順ルートを求める場合、経由地は2地点以上登録する必要があります。
経由地指定の上限数は、指定順ルート/最適順ルートどちらとも10地点です。出発地点、到着地点は含みません。
上限数を超える経由地を指定するとエラーとなります。
JSON 表現は URL エンコードをした上でリクエストしてください。
パラメータ構成例
・出発地：東京都庁、目的地：東京スカイツリー、出発時刻：2021年3月1日10時のルートをGPS測位モードで案内
/webnavi/bicycle?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/bicycle?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・位置情報サービス」を使用します。