交通費計算(トータルナビ)

/widget/calc_cost [GET]

基本情報

概要

交通費計算を行うWebコンテンツ (HTML, JavaScript, CSS) を取得します。
※当APIをご利用の場合は、オプション契約が別途必要となります

URL

https://{HOST}/{CID}/v1/widget/calc_cost

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

出力形式

  • HTML
  • JavaScript
  • CSS
  • JSON

対応言語

  • ja

交通費計算Widget画面の呼び出しについて

経路や運賃などの情報を返却する呼び出し元画面は、サーバ上に配置したHTMLファイルである必要があります。

交通費計算Widget画面の認証について

下記のいずれかの方法でアクセス制限を設定することができます。
・IP制限(推奨)
お客様のCIDを利用するリクエストについて、指定したIPアドレス以外からのアクセスを拒否します。
第三者による不正アクセスを防ぐことができますが、お客様のサーバ側で交通費計算Widgetを返却する処理の実装が必要となります。
・ホスト制限
お客様のCIDを利用するリクエストについて、指定したホスト(リファラ)以外からのアクセスを拒否します。
簡易的な実装のみで交通費計算Widgetを利用することができますが、リファラは改ざん可能なため、セキュリティレベルが低くなります。

※IPが一意に定まらない環境をご使用の場合は、ホスト制限のみをご利用ください。

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
host サイトのドメイン 文字列
parts_color 各パーツのカラー 文字列(「#」より後ろのカラーコード) 007800 3桁もしくは6桁のカラーコードに対応しています
back_color 背景カラー 文字列(「#」より後ろのカラーコード) f9fdff 3桁もしくは6桁のカラーコードに対応しています
commuter_pass 定期券区間指定 文字列 レスポンス「commuter_pass_info」の値を指定してください(詳細はこちらをご覧ください)
以下の場合は定期券区間を指定しても無効になります
・経由地を指定した場合
・新幹線を利用する場合
・定期券区間が100kmを超える場合

定期券区間の指定について

定期券区間を指定する場合、一度指定したい定期券区間をウィジェットから取得する必要があります。
ウィジェットで取得した結果に定期券情報が存在する場合、「commuter_pass_info」として返却されます。

パラメータ構成例

・https://example.com/foo/baa.html のサイト上で各パーツのカラー(#264A84)と背景カラー(#DBDEDD)を指定し取得

/widget/calc_cost?host=example.com&parts_color=264A84&back_color=DBDEDD

レスポンス

名称 レスポンス名 型名 配列 説明
出発地点 start SpotInfoオブジェクト
目的地点 goal SpotInfoオブジェクト
経由地点 via SpotInfoオブジェクト 経由地指定時のみ出力
乗換回数 transit_count 数値
運賃
(ICカード/きっぷ, 片道/往復)
fare 数値 運賃が存在する場合のみ出力
ウィジェット上の条件設定により、同一経路でも出力される値が変化します
総所要時間(単位:分) time 数値
総距離(単位:m) distance 数値
定期券運賃 total_commuter_pass TotalCommuterPassオブジェクト
乗車駅, 降車駅のリスト node_list 文字列
乗車路線のリスト link_list 文字列
各路線の運賃情報 transport_sections TransportSectionsオブジェクト
定期券区間情報 commuter_pass_info 文字列 定期券のデータが存在する場合のみ出力
定期券区間を指定する場合、この値をパラメータ「commuter_pass」に設定してください

SpotInfoオブジェクト

名称 レスポンス名 型名 配列 説明
地点の名称 name 文字列 駅名もしくは住所から検索した場合のみ出力
緯度経度 coord Coordinateオブジェクト

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
緯度 lat 数値
経度 lon 数値

TotalCommuterPassオブジェクト

名称 レスポンス名 型名 配列 説明
列車の定期券運賃 train CommuterPassオブジェクト 列車の定期券運賃が存在する場合のみ出力
バスの定期券運賃 bus CommuterPassオブジェクト バスの定期券運賃が存在する場合のみ出力

CommuterPassオブジェクト

名称 レスポンス名 型名 配列 説明
1ヶ月の運賃 1_month 数値 1ヶ月通勤定期のデータが存在する場合のみ出力
3ヶ月の運賃 3_months 数値 3ヶ月通勤定期のデータが存在する場合のみ出力
6ヶ月の運賃 6_months 数値 6ヶ月通勤定期のデータが存在する場合のみ出力

TransportSectionsオブジェクト

名称 レスポンス名 型名 配列 説明
移動手段 move_type 文字列
路線名 link_name 文字列
乗車駅と降車駅情報 node Nodeオブジェクト
運賃 fare 数値 運賃が存在する場合のみ出力
定期券運賃 commuter_pass CommuterPassオブジェクト 定期券運賃が存在する場合のみ出力

Nodeオブジェクト

名称 レスポンス名 型名 配列 説明
乗車駅名称 from 文字列
降車駅名称 to 文字列

バスデータの利用について

バス利用を含むルート検索には別途利用契約が必要になります(ご契約されていない状態ですと利用できません)
ご希望の場合は、営業担当もしくはサポートまでご連絡ください。

時刻表データの利用について

時刻表データ利用はオプション機能のため、別途契約が必要になります。
※時刻表オプション利用時のみ経路検索結果における時刻表示を行います
※時刻表データ利用のオプションをご利用しない場合は、ナビタイム独自の平均時間を用いた経路検索を行います

平均時間を用いた経路検索について

詳細は、Tipsの平均時間を用いた乗換検索をご確認ください。

本APIのサンプルについて

サンプルはこちらからご確認いただけます。

レスポンス例

{
    "start": {
        "name": "品川",
        "coord": {
            "lat": 35.628066,
            "lon": 139.738891
        }
    },
    "goal": {
        "coord": {
            "lat": 35.667399,
            "lon": 139.714888
        }
    },
    "via": {
        "name": "渋谷",
        "coord": {
            "lat": 35.658514,
            "lon": 139.701692
        }
    },
    "transit_count": 1,
    "fare": 336,
    "time": 26,
    "distance": 8906,
    "total_commuter_pass": {
        "train": {
            "1_month": 11700,
            "3_months": 33340,
            "6_months": 60020
        }
    },
    "node_list": [
        "品川",
        "渋谷",
        "表参道"
    ],
    "link_list": [
        "JR山手線",
        "東京メトロ銀座線"
    ],
    "transport_sections": [
        {
            "move_type": "local_train",
            "link_name": "JR山手線",
            "node": {
                "from": "品川",
                "to": "渋谷"
            },
            "fare": 168,
            "commuter_pass": {
                "1_month": 5270,
                "3_months": 15010,
                "6_months": 25290
            }
        },
        {
            "move_type": "local_train",
            "link_name": "東京メトロ銀座線",
            "node": {
                "from": "渋谷",
                "to": "表参道"
            },
            "fare": 168,
            "commuter_pass": {
                "1_month": 6430,
                "3_months": 18330,
                "6_months": 34730
            }
        }
    ]
}

動作環境について

当 API の動作環境は次のとおりです。

【ブラウザ】

  • Safari 最新バージョン
  • Google Chrome 最新バージョン

スマホ・タブレットでの表示について

スマホやタブレットを使用した表示に対応しています。