ナビゲーション(徒歩)

/webnavi/walk [GET]

基本情報

概要

徒歩を移動手段として、目的地までの経路を案内する Web コンテンツ (HTML, JavaScript, CSS) を取得します。
※当APIをご利用の場合は、ナビゲーション利用のオプション契約が別途必要となります

URL

https://{HOST}/{CID}/v1/webnavi/walk

※Rakuten RapidAPIでは提供しておりません

出力形式

  • 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との併用は不可(どちらか片方を必ず指定)
speed 徒歩の速度(単位:km/h) 数値 5.0 最小値:3.0
最大値:8.0
小数値は第一位まで有効です
condition 徒歩ルート検索の優先考慮事項 文字列 recommend recommend: 推奨ルート
distance: 距離が短いルート
spec_id (✔) ユーザー識別子 文字列 1文字以上50文字以内 当APIを使用する場合はリクエストヘッダー「x-ntj-spec-id」、または、パラメータ「spec_id」を必ず設定してください

リクエストヘッダー「x-ntj-spec-id」を指定する場合は「spec_id」の指定は不要です
mode 経路案内モード 文字列 normal normal:GPS測位モード
simulation:シミュレーションモード
notice_url 目的地到着時に通知を行うURL 文字列
host サイトのドメイン 文字列
platform プラットフォーム 文字列 browser browser : ブラウザで利用
app: アプリケーションで利用
当APIを動かす環境を指定します

緯度経度の測地系について

当 API では、「世界測地系」のみご利用頂けます。

緯度経度の表記について

当 API では、「度表記」のみご利用頂けます。

歩行速度の指定について

所要時間の精度向上のため、指定された速度を基準にルートの諸条件を考慮したものが利用されます。
必ずしも指定した速度の通りの所要時間にはならないことがありますので、予めご了承ください。

 

当 API の挙動として、案内を開始する前にルート検索を行います。
/route_walk のルート検索結果と出力を合わせる場合は、ルート検索時と同じ検索条件(パラメータの設定)でリクエストしてください。

地点の JSON 表現

プロパティ名 必須 概要 型名 デフォルト値 備考
lat 緯度 数値
lon 経度 数値

 

JSON 表現は URL エンコードをした上でリクエストしてください。

パラメータ構成例

・出発地:東京都庁、目的地:東京スカイツリー、出発時刻:2021年3月1日10時のルートをGPS測位モードで案内

/webnavi/walk?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/walk?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" というファイルが再生されます
  • ブラウザの仕様変更により画面がスリープ状態になってしまう可能性があります
  • Android の iframe には対応しておりません

共通要件

端末機能「GPS・位置情報サービス」を使用します。