メインコンテンツにスキップ

エネがえるAPIが自社要件に合うか?Yes/NoでAPI構成案と確認事項を整理するテンプレート

共通公開API仕様書を起点に、目的・入力データ・契約別要件からAPI構成案を整理します。提供可否・実装適合の確定には対象仕様と契約の確認が必要です。

対応者:樋口 悟

このテンプレは、要件をYes/Noで確認し、必要なAPI構成案と追加確認事項を整理するためのものです。契約別の提供可否や実装適合を自動確定するものではありません。共通公開定義(OpenAPI 3.0 / v1.0.0)は2026年10月10日に確認しました。認証付き実APIによる動作試験は今回行っていません。

最初に確認する正本

エネがえる共通 公開用 API(OpenAPI 3.0 / v1.0.0)

1. 目的から選ぶ:Yes/No判定

Q1. 電気事業者や料金プランの候補・詳細が必要ですか?

YES → GET /sys/epcorps、GET /sys/epplans、GET /sys/epplans/{epplan_id}/{base_cd}/{capacity}

Q2. 電気料金や市場連動型料金を計算しますか?

YES → POST /sys/epchargecalc

30分値は day_purchase を1日48コマで指定します。市場連動型の価格参照期間、燃料費調整額、purchase の期間制約、capacity の要否は必ず最新版仕様書で確認してください。

Q3. 月別使用量から30分単位の電力使用量を推計しますか?

YES → POST /sys/usepowercalc

Q4. 太陽光発電量を推計しますか?

YES → POST /sys/pvpowercalc

Q5. 太陽光・PCS・蓄電池を組み合わせた設備シミュレーションが必要ですか?

YES → POST /sys/equipsimulation

Q6. 国・都道府県・市区町村のスマエネ補助金を検索・取得しますか?

YES → GET /sys/subsidy、GET /sys/subsidy/{id}

Q7. ガス料金、オール電化前後の消費量、機器の負荷プロファイルを扱いますか?

YES → 必要な処理に応じて次の共通公開APIを組み合わせます。
・GET /sys/gascorps、GET /sys/gasplans:都市ガスの事業者・料金プランを取得。
・POST /sys/usegascalc:1ヶ月のガス使用実績から12ヶ月の月別・用途別使用量を推計。
・POST /sys/gasconvert:ガス熱量(MJ)から電気使用量(kWh)へ換算。
・POST /sys/applianceprofile:機器の動作条件に合わせて30分単位の消費電力量等を計算。
・POST /sys/gaschargecalc:月別ガス使用量と料金プランからガス料金を計算。
現行共通公開定義のガス12ヶ月推計パスは /sys/usegascalc です。必須項目、単位、配列長、対象ガス種別を仕様書で確認してください。applianceprofileではガス暖房は電化シミュレーション対象外で、暖房分は残ガスとして扱います。電気料金の比較には必要な電力使用量をそろえてPOST /sys/epchargecalcへ接続します。

Q8. EV・V2H、産業用Biz、AI Sense、設備制御、独自料金ロジックなど、契約別・個別提供の要件がありますか?

YES → 共通公開仕様書だけで提供可否を断定せず、対象設備・データ・計算ロジック・画面要件を整理して営業・技術担当へ確認してください。

2. 代表的なAPI構成

料金プラン比較

login → epcorps → epplans → 料金プラン詳細 → epchargecalc → logout

月別使用量からの料金試算

login → usepowercalc → epchargecalc → logout

太陽光・蓄電池の経済効果試算

login → usepowercalc → pvpowercalc → equipsimulation → epchargecalc → logout

補助金連携

login → subsidy → subsidy/{id} → logout

ガス・オール電化比較

login → 必要に応じて gascorps / gasplans → usegascalc。
ここから目的別に分けます。
・電化前のガス料金:usegascalcのmonthly_gas → gaschargecalc。
・電化後の電気使用量:usegascalc → gasconvert → applianceprofile。必要な電力使用量をそろえ、epchargecalcで料金を計算します。
・電化後に残るガス料金:applianceprofileにmonthly_gasを渡した場合に返るremaining_gas_monthly(残ガス量:m³)を、gaschargecalcのmonthly_gasへ指定します。
最後にlogout。各APIの入力・出力スキーマと必要な追加パラメータを確認してください。出力が無条件にそのまま次の入力になる意味ではありません。

3. 導入前に確定する項目

・対象顧客:住宅/低圧/高圧/その他

・対象設備:太陽光、蓄電池、EV、V2H、充電器、ガス機器など

・入力データ:月別/日別/30分値、欠損時の推計方法

・必要な出力:料金、削減額、自家消費率、発電量、補助金など

・料金プラン条件:契約容量、燃料費調整、再エネ賦課金、市場連動、独自割引

・非機能要件:想定件数、応答時間、認証、ログ、個人情報、保守分担

・希望時期:検証開始、公開、運用開始

重要

このテンプレートの共通エンドポイントは上記の共通公開API仕様書を正本としています。旧V4や契約別のBiz・EV・AI Sense等をご利用の場合は、その接続先と契約に対応する仕様書を確認してください。共通公開定義に載っていない機能の提供可否は個別に確認してください。

こちらの回答で解決しましたか?