エネがえる v4 API WEBサンプル1(電気料金比較)
© 2020 KOKUSAI KOGYO CO., LTD.

はじめに

これは 「エネがえる v4 API」を利用する WEBアプリケーションサンプルです。

サンプル1では、主に電気料金比較に用いる APIを中心に使用し、次のような流れとなっています。

処理ステップ(使用するAPI)処理内容
(ログイン) 0.ログイン (login) ユーザー名/パスワード でログインし、認証トークンを取得します。
現在の料金プラン選択 1.電気事業者取得 (epcorps) 都道府県を指定し、契約可能な電気事業者のリストを取得します。
2.料金プラン取得 (epplans) 電気事業者を指定し、料金プランのリストを取得します。
3.料金プラン選択 (なし) 現在契約している料金プランを選択します。
現在の料金計算 4.電気使用量計算 (usepowercalc) 入力された月の使用量をもとに、都道府県別のテンプレートを使って12ヵ月分の使用量を計算し、 生活スタイルから時間毎の使用量を計算します。
5.電気料金計算 (epchargecalc) Step 4で計算した使用量に対する、現在の料金プランでの電気料金を計算します。
他の料金プランとの比較 6.比較する料金プランの選択 (extractepplans) 契約タイプ(電灯/電力)、契約容量 等により比較する料金プランを抽出します。
7.電気料金比較 (epdiagnosis) Step 6で抽出した全ての料金プランでの電気料金を計算します。

各ステップで「APIの実行」を押すと APIをコールして、実行結果を表示します。
(実際の APIのレスポンスは ブラウザ搭載の開発者ツールのコンソールに出力します。)
なお、サンプルのため、入力チェックや細かい制御等は行っていません。

このWEBアプリケーションではブラウザのみで実行可能なよう、ブラウザの javascript で APIを呼び出していますが、
実際のご利用においては、サーバーサイドのプログラムから呼び出す形を想定しています。

Step0: ログイン

ログインをして認証トークンを取得します。

初期状態ではお試し用の共通のものが定義されていますが、別途 指定のものが提供されている場合は、 'common.js' 内の所定部分を変更した上て読込みを行ってください。

主なAPIパラメータ

  • API key:
  • ユーザー名:
  • パスワード:

Step1: 電気事業者取得

都道府県を指定して契約可能な電気事業者を取得します。

主なAPIパラメータ

  • 都道府県:

Step2: 料金プラン取得

電気事業者を指定して料金プランを取得します。

主なAPIパラメータ

  • 電気事業者:

Step3: 料金プランの選択

(ここは選択のみで APIはコールしません。)

主なパラメータ

  • 料金プラン:

Step4: 電気使用量計算

電気使用量の推計を行います。

  1. 入力された月の使用量をもとに、都道府県別の12カ月の使用量比率のテンプレートを使って未入力の月の使用量を計算します。
  2. 入力された生活スタイルで1日の時間ごとの使用量に分解します。

実績データや独自のロードカーブがあれば、この APIを使用せず直接データをセットして電気料金計算(Step5)を実行することも可能です。

主なAPIパラメータ

  • 都道府県:(Step1 で選択した都道府県を用います)
  • 生活スタイル:
  • 時間帯別入力
    時:
    時:
    時:
  • 月平均電気使用量(kWh):
  • 特定月の電気使用量(kWh):
     1月  2月  3月
     4月  5月  6月
     7月  8月  9月
    10月 11月 12月

Step5: 電気料金計算

ここでは、入力例としてこれまでの結果をセットして APIを実行しますが、別のデータをパラメータとしてセットすることも可能です。
例えば、電気使用量を実績データや独自のロードカーブに置き換えることが可能です。

主なAPIパラメータ

  • 電気事業者:Step2で選択した事業者
  • 料金プラン:Step3で選択したプラン
  • 電気使用量:Step4で計算した使用量

Step6: 比較する料金プランの選択

ここでは、APIを使用して比較する料金プランを抽出していますが、APIを使用せず独自のルールで比較する料金プランを設定し、 料金比較(Step7)を行うことも可能です(自社のおすすめプランなど)。

主なAPIパラメータ

  • 料金プランの情報:Step3 で選択した料金プランのアンペア数、契約種別等の情報
  • 比較する電気事業者:(例として Step1 で取得した電気事業者の中から先頭の4つをセットしてAPIをコールします。)

Step7: 電気料金比較

複数の料金計算を一括して行う(並列実行)ことが可能です。
比較する事業者コード、料金プランコードがわかっていれば、Step6をスキップして直接値を設定可能です。

主なAPIパラメータ

  • 料金プランの情報:Step3 で選択した料金プランの情報
  • 電気使用量:Step4で計算した使用量
  • 比較する料金プラン:(例として Step6 で取得した料金プランをセットしてAPIをコールします。)

終了

以上でこのWEBサンプルは終了です。

お疲れ様でした。