交通費計算(トータルナビ)
/widget/calc_cost [GET]
基本情報
概要
交通費計算を行うWebコンテンツ (HTML, JavaScript, CSS) を取得します。
※当APIをご利用の場合は、オプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/widget/calc_cost
※APIマーケットでは提供しておりません
出力形式
- 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」の値を指定してください(詳細はこちらをご覧ください) 以下の場合は定期券区間を指定しても無効になります ・経由地を指定した場合 ・新幹線を利用する場合 ・定期券区間が300kmを超える場合 |
|||
| enable_time | 時刻設定フォームの有無 | 真偽値 | true | false：経路探索時の発着時刻設定を省略 | falseを指定した場合、ウィジェットに時刻指定フォームは表示されません。 | |
| customize | ウィジェットに表示する条件項目の表示設定 | 条件項目表示設定のJSON表現 |
条件項目表示設定の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| customize | ✔ | 条件項目表示設定 | Customizeオブジェクト | 条件項目の表示設定 | |
| how_to_disable | 選択不可項目表示状態 | 文字列 | grayed-out | grayed-out：グレーアウト invisible：非表示 |
・Customizeオブジェクト
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| fare | ✔ | 運賃設定 | Fareオブジェクト | ||
| is_round | ✔ | 片道・往復設定 | IsRoundオブジェクト | ||
| order | ✔ | 表示順序設定 | Orderオブジェクト | ||
| use_condition | ✔ | 使用路線設定 | UseConditionオブジェクト |
・Fareオブジェクト
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| default | ✔ | デフォルト設定値 | 文字列 | ic | ic：IC支払い ticket：切符支払い |
| disable | ✔ | 選択不可 | 真偽値 | true | true：選択不可状態とする false：選択可能状態とする |
・IsRoundオブジェクト
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| default | ✔ | デフォルト設定値 | 文字列 | one_way | one_way：片道 round_trip：往復 |
| disable | ✔ | 選択不可 | 真偽値 | true | true：選択不可状態とする false：選択可能状態とする |
・Orderオブジェクト
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| default | ✔ | デフォルト設定値 | 文字列 | time | time：所要時間 transit：乗換回数 fare：料金 |
| disable | ✔ | 選択不可 | 真偽値 | true：選択不可状態とする false：選択可能状態とする |
・UseConditionオブジェクト
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| default | ✔ | デフォルト設定値 | 配列 | airplane：飛行機 superexpress：新幹線 express：有料列車 bus：路線バス highwaybus：高速バス いずれも指定しない場合は空の配列 |
|
| disable | ✔ | 選択不可 | 真偽値 | true：選択不可状態とする false：選択可能状態とする |
定期券区間の指定について
定期券区間を指定する場合、一度指定したい定期券区間をウィジェットから取得する必要があります。
ウィジェットで取得した結果に定期券情報が存在する場合、「commuter_pass_info」として返却されます。
customizeパラメータの指定方法について
customizeパラメータを指定することで、運賃表示、片道・往復、表示順序、使用路線の各設定項目の表示・非表示、表示状態やデフォルト選択値を設定できます。
■例1）
・料金 デフォルト値： IC / 選択不可
・片道・往復 デフォルト値： 片道 / 選択可
・表示順序 デフォルト値： 乗換回数順 / 選択不可
・利用路線 デフォルト値： 飛行機・有料列車 / 選択可
・選択不可項目はグレーアウトする
customize={"customize": {"fare": {"default": "ic","disable": "true"},"is_round": {"default": "one_way","disable": "false"},"order": {"default": "transit","disable": "true"},"use_condition": {"default": ["airplane","express"],"disable": "false"} },"how_to_disable": "grayed-out"}
■例2）
・料金 デフォルト値： 切符 / 選択可
・片道・往復 デフォルト値： 往復 / 選択可
・表示順序 デフォルト値： 料金 / 選択不可
・利用路線 デフォルト値： 新幹線・有料列車・高速バス / 選択不可
・選択不可項目は非表示とする
customize={"customize": {"fare": {"default": "ticket","disable": "false"},"is_round": {"default": "round_trip","disable": "false"},"order": {"default": "transit","disable": "true"},"use_condition": {"default": ["superexpress","express","highwaybus"],"disable": "true"} },"how_to_disable": "invisible"}
■例3）
※デフォルト表示と同じ状態にしたい場合
・料金 デフォルト値： IC / 選択可
・片道・往復 デフォルト値： 片道 / 選択可
・表示順序 デフォルト値： 所要時間 / 選択可
・利用路線 デフォルト値： なし / 選択可
customize={"customize": {"fare": {"default": "ic", "disable": "false"}, "is_round": {"default": "one_way", "disable": "false"}, "order": {"default": "time", "disable": "false"}, "use_condition": {"default": [], "disable": "false"}}}
パラメータ構成例
・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": [
"ＪＲ山手線",
"東京メトロ銀座線"
],
"transport_sections": [
{
"move_type": "local_train",
"link_name": "ＪＲ山手線",
"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 最新バージョン
スマホ・タブレットでの表示について
スマホやタブレットを使用した表示に対応しています。