コンテンツにスキップ

交通費計算（車）

/widget/calc_cost_car [GET]

基本情報

概要

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

URL

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

※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桁のカラーコードに対応しています
search_condition 検索条件復元用パラメータ 文字列
departure_time 出発時刻 文字列(時刻)hh:mm 指定可能範囲は00:00~23:59です ・指定例　09:30
・この値を指定した場合、当日の指定時刻を出発時刻とします
・画面上の出発時刻指定フォームをマスクします

検索条件復元用パラメータの指定について

検索条件復元用パラメータを指定する場合、車のルート検索結果をウィジェットから取得する必要があります。
ウィジェットで取得した結果に「search_condition」として返却されます。

パラメータ構成例

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

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

レスポンス

名称 レスポンス名 型名 配列 説明
出発地点 start SpotInfoオブジェクト
目的地点 goal SpotInfoオブジェクト
経由地点 via SpotInfoオブジェクト 経由地指定時のみ出力
料金情報 fare Fareオブジェクト 運賃が存在する場合のみ出力
ウィジェット上の条件設定により、同一経路でも出力される値が変化します
有料道路走行距離(単位：m) toll_road_distance 数値
総所要時間(単位：分) time 数値
総移動距離(単位：m) distance 数値
タクシー料金 taxi 数値
検索条件復元用パラメータ search_condition 文字列

SpotInfoオブジェクト

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

Coordinateオブジェクト

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

Fareオブジェクト

名称 レスポンス名 型名 配列 説明
料金 unit_{料金区分ID}_{車種ID} 数値 〇

大型車の規制情報の利用について

大型車の規制情報利用はオプション機能のため、別途契約が必要となります。
ご契約いただくと、下記の項目を詳細条件として指定することができます。
・車両区分
・料金車種区分
・車高/車幅/車長/車重
・最大積載量
・危険物積載車両通行規制考慮

本APIのサンプルについて

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

レスポンス例

{
    "start": {
        "name": "東京都港区南青山3丁目8",
        "coord": {
            "lat": 35.666939,
            "lon": 139.715201
        }
    },
    "goal": {
        "name": "東京ディズニーランド",
        "coord": {
            "lat": 35.632548,
            "lon": 139.881327
        }
    },
    "via": {
        "name": "東京タワー",
        "coord": {
            "lat": 35.658636,
            "lon": 139.745406
        }
    },
    "fare": {
        "unit_1024_1": 1590,
        "unit_1024_2": 1950,
        "unit_1024_3": 2310,
        "unit_1024_4": 3110,
        "unit_1024_5": 5080,
        "unit_1025_1": 540,
        "unit_1025_2": 640,
        "unit_1025_3": 730,
        "unit_1025_4": 940,
        "unit_1025_5": 1460
    },
    "toll_road_distance": 13245,
    "time": 38,
    "distance": 21261,
    "taxi": 7300,
    "search_condition": "%7B%22start%22:%22%7B%22lon%22:139.715013,%22lat%22:35.667212,%22name%22:%22%E6%9D%B1%E4%BA%AC%E9%83%BD%E6%B8%AF%E5%8C%BA%E5%8D%97%E9%9D%92%E5%B1%B13%E4%B8%81%E7%9B%AE8-38%22%7D%22,%22goal%22:%22%7B%22lon%22:139.881327,%22lat%22:35.632548,%22name%22:%22%E6%9D%B1%E4%BA%AC%E3%83%87%E3%82%A3%E3%82%BA%E3%83%8B%E3%83%BC%E3%83%A9%E3%83%B3%E3%83%89%22%7D%22,%22smart_ic%22:%22unuse%22,%22ferry%22:%22unuse%22,%22etc%22:%22unuse%22,%22wide%22:%22unuse%22,%22condition%22:%22recommend%22,%22via%22:%22%5B%7B%22lon%22:139.745406,%22lat%22:35.658636,%22name%22:%22%E6%9D%B1%E4%BA%AC%E3%82%BF%E3%83%AF%E3%83%BC%22%7D%5D%22,%22start_time%22:%222022-06-07T09:00%22%7D"
}

動作環境について

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

【ブラウザ】

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

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

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