Back to top

産業用自家消費型太陽光・蓄電池経済効果診断API - エネがえる biz 公開用 API

as of 2024/10/01　[変更履歴]
ログイン・ログアウト、単機能のシミュレーション、料金計算など基本的なAPIをご提供します。

API共通のエラーコード

API共通のエラーコード

エラーの種類によって、次の http response を返します。 (エラーメッセージの内容以外は API, method によらず同じです)

400エラーの場合は原則としてエラーメッセージがテキストで返されます。

  • 400 : パラメータエラー等のリクエスト内容に起因するエラー

  • 403 : 認証エラー（有効でない認証トークン）

  • 500 : システム内部エラー（API内部での処理エラー：エネがえる担当者にご連絡ください）

  • 504 : タイムアウト（再実行しても改善されない場合、エネがえる担当者にご連絡ください）

API共通
GET/xxxx

Example URI

GET https://api.enegaeru.com/biz/xxxx
Response  400
Response  403
Response  500
Response  504

API共通
POST/xxxx

Example URI

POST https://api.enegaeru.com/biz/xxxx
Response  400
Response  403
Response  500
Response  504

API共通
PUT/xxxx

Example URI

PUT https://api.enegaeru.com/biz/xxxx
Response  400
Response  403
Response  500
Response  504

API共通
DELETE/xxxx

Example URI

DELETE https://api.enegaeru.com/biz/xxxx
Response  400
Response  403
Response  500
Response  504

シミュレーション

電気使用量計算

電気使用量計算
POST/usepowercalc/

現在の月別電気使用量、ロードカーブパターン、カレンダールールにより電気使用量を推計します。

Example URI

POST https://api.enegaeru.com/biz/usepowercalc/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "patterns": [
    {
      "name": "繁忙期",
      "epRatio": 1.2,
      "hourlyRatios": [
        10.01
      ]
    }
  ],
  "calendarInfo": {
    "calendars": [
      {
        "rules": [
          {
            "type": 0,
            "range": [
              "08/15"
            ],
            "dayOfWeeks": [
              0
            ],
            "holidayType": 0
          }
        ],
        "patternIdx": 0
      }
    ],
    "defaultPatternIdx": 0,
    "latest": "2021-07",
    "epowers": [
      20000
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "patterns": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "パターン名"
          },
          "epRatio": {
            "type": "number",
            "description": "パターンごとの１日の総電気使用量の相対値"
          },
          "hourlyRatios": {
            "type": "array",
            "items": {
              "type": "number"
            },
            "description": "時間ごとの電気使用量比率 (長さ24の配列 (0時～23時))"
          }
        },
        "required": [
          "epRatio",
          "hourlyRatios"
        ]
      },
      "description": "ロードカーブパターンの配列"
    },
    "calendarInfo": {
      "type": "object",
      "properties": {
        "calendars": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "rules": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "number",
                      "description": "ルールタイプ (0: 特定の日付による指定, 1: 曜日による指定)"
                    },
                    "range": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "長さ2の配列 (開始日と終了日) (type=0 の場合)"
                    },
                    "dayOfWeeks": {
                      "type": "array",
                      "items": {
                        "type": "number"
                      },
                      "description": "適用する曜日(0～6:日曜日～土曜日)の配列 (type=1 の場合)"
                    },
                    "holidayType": {
                      "type": "number",
                      "description": "祝日の扱い (0:すべて, 1:祝日のみ, 2:祝日以外) (type=2 の場合、dayOfWeeksと組み合わせて指定)"
                    }
                  },
                  "required": [
                    "type"
                  ]
                },
                "description": "ルールの配列"
              },
              "patternIdx": {
                "type": "number",
                "description": "条件に合致した場合に使用するロードカーブパターン (patternsの該当する index)"
              }
            },
            "required": [
              "rules",
              "patternIdx"
            ]
          },
          "description": "ルールの配列"
        },
        "defaultPatternIdx": {
          "type": "number",
          "description": "calendars のすべての条件に合致しない場合に使用するロードカーブパターン (patternsの該当する index)"
        },
        "latest": {
          "type": "string",
          "description": "最新月(YYYY-MM形式)"
        },
        "epowers": {
          "type": "array",
          "items": {
            "type": "number"
          },
          "description": "各月の電気使用量(kWh)(長さ12の配列 (1月～12月))"
        }
      },
      "required": [
        "calendars",
        "defaultPatternIdx",
        "latest",
        "epowers"
      ],
      "description": "カレンダールール"
    }
  },
  "required": [
    "patterns",
    "calendarInfo"
  ]
}
Response  200
HideShow
Body
[
  {
    "month": "2020-01",
    "purchase": 20000,
    "peak_purchase": 80,
    "dailydata": [
      {
        "day": 1,
        "dayOfWeek": 0,
        "holiday": 0,
        "patternIdx": 0,
        "day_purchase": [
          20
        ]
      }
    ]
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "month": {
        "type": "string",
        "description": "年月(YYYY-MM形式)"
      },
      "purchase": {
        "type": "number",
        "description": "電気使用量の月合計"
      },
      "peak_purchase": {
        "type": "number",
        "description": "電気使用量の月ピーク値"
      },
      "dailydata": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "day": {
              "type": "number",
              "description": "日"
            },
            "dayOfWeek": {
              "type": "number",
              "description": "曜日(0～6:日曜日～土曜日)"
            },
            "holiday": {
              "type": "number",
              "description": "祝日フラグ(0:平日、1:祝日)"
            },
            "patternIdx": {
              "type": "number",
              "description": "適用したロードカーブパターン (patternsの該当する index)"
            },
            "day_purchase": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間使用量 (長さ24の配列 (0:00～23:00))"
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

太陽光発電量計算

太陽光発電量計算
POST/pvpowercalc/

設置地点、太陽光パネル情報から太陽光発電量を計算します。(パワコンによる損失・出力上限等は equipsimulation で計算します。)

  • maker_correction あるいは panels のいずれかが必須

Example URI

POST https://api.enegaeru.com/biz/pvpowercalc/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "point_no": 44132,
  "maker_correction": 4200,
  "panels": [
    {
      "installation": 2,
      "basic_coeff": 0.76,
      "azimuth": 0,
      "tilt": 23,
      "vol": 4,
      "maxtemp_coeff": -0.44
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "point_no": {
      "type": "number",
      "description": "地域番号"
    },
    "maker_correction": {
      "type": "number",
      "description": "メーカー補正値"
    },
    "panels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "installation": {
            "type": "number",
            "description": "設置形態（1:架台設置, 2:屋根置き, 3:建材一体）"
          },
          "basic_coeff": {
            "type": "number",
            "description": "基本設計係数 (0.65～0.99)"
          },
          "azimuth": {
            "type": "number",
            "description": "方位角 (-179～180度)"
          },
          "tilt": {
            "type": "number",
            "description": "傾斜角 (0～90度)"
          },
          "vol": {
            "type": "number",
            "description": "出力値 1方角あたりの出力(kWh)"
          },
          "maxtemp_coeff": {
            "type": "number",
            "description": "最大出力温度係数（結晶系:-0.44, 化合物:-0.31, 薄膜ハイブリッド:-0.35, アモルファス:-0.21）"
          }
        },
        "required": [
          "installation",
          "basic_coeff",
          "azimuth",
          "tilt",
          "vol",
          "maxtemp_coeff"
        ]
      },
      "description": "太陽光パネルの情報 (配列)"
    }
  },
  "required": [
    "point_no"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "month": "xxxx-01",
    "pvpower": 400,
    "dailydata": [
      {
        "day": 1,
        "day_pvpower": [
          0
        ]
      }
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "month": {
        "type": "string",
        "description": "年月(YYYY-MM形式, 年固定のデータではないため 'xxxx'が入ります。)"
      },
      "pvpower": {
        "type": "number",
        "description": "月合計"
      },
      "dailydata": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "day": {
              "type": "number",
              "description": "日"
            },
            "day_pvpower": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "1日の各時間の配列(長さ24(0:00～23:00))"
            }
          }
        }
      }
    }
  }
}

設備導入シミュレーション

設備導入シミュレーション
POST/equipsimulation/

電気使用量、太陽光発電量、パワコンおよび蓄電池の設定に基づき、利用シミュレーションを行います。
以下の場合、エラーとなります。

  • usepowers のデータの範囲が１年以上の場合。

  • usepowersレコード（日） に対応する pvpowersレコード（日）がない場合（pvpowers自身 が nullの場合は太陽光発電なしとして扱います）。

買電量を peakLimit（設定ピーク値）に抑えるよう蓄電池の放電を行います（充電時間帯以外）。また、 discharge_from/to（放電可能時間帯）は peakLimit（設定ピーク値）に関わらず放電を行います。 charge_from と charge_to、discharge_from と discharge_to に同じ値を指定した場合は、充電 または 放電（ピークシフトを除く）を行いません。 ただし、charge_from/to（または discharge_from/to）両方に 0 を指定した場合は、常時充電（または放電）可能となります。

Example URI

POST https://api.enegaeru.com/biz/equipsimulation/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "usepowers": [
    {
      "month": "2020-01",
      "dailydata": [
        {
          "day": 1,
          "day_purchase": [
            20
          ]
        }
      ]
    }
  ],
  "pvpowers": [
    {
      "month": "2020-01",
      "dailydata": [
        {
          "day": 1,
          "day_pvpower": [
            0
          ]
        }
      ]
    }
  ],
  "pcsInfo": {
    "pcsConversion": 98,
    "pcsOutput": 400
  },
  "minPurchase": 1,
  "useCut2cell": true,
  "noEp2cell": false,
  "cellInfo": {
    "actual_capacity": 90,
    "charge_coeff": 97,
    "charge_vol": 1,
    "discharge_coeff": 97,
    "discharge_vol": 1,
    "peakLimit": 80,
    "charge_from": 23,
    "charge_to": 5,
    "discharge_from": 5,
    "discharge_to": 23,
    "usePv2cell": true
  },
  "monthlySetting": [
    {
      "months": [],
      "peakLimit": 80,
      "charge_from": 23,
      "charge_to": 5,
      "discharge_from": 5,
      "discharge_to": 23,
      "usePv2cell": true,
      "pv4cell": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "usepowers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "month": {
            "type": "string",
            "description": "年月(YYYY-MM形式)"
          },
          "dailydata": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "day": {
                  "type": "number",
                  "description": "日"
                },
                "day_purchase": {
                  "type": "array",
                  "items": {
                    "type": "number"
                  },
                  "description": "１日の各時間使用量 (長さ24の配列 (0:00～23:00))"
                }
              },
              "required": [
                "day",
                "day_purchase"
              ]
            }
          }
        },
        "required": [
          "dailydata"
        ]
      },
      "description": "各月の配列"
    },
    "pvpowers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "month": {
            "type": "string",
            "description": "年月(YYYY-MM形式)"
          },
          "dailydata": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "day": {
                  "type": "number",
                  "description": "日"
                },
                "day_pvpower": {
                  "type": "array",
                  "items": {
                    "type": "number"
                  },
                  "description": "1日(月平均)の各時間の配列(長さ24の配列(0:00～23:00))"
                }
              },
              "required": [
                "day",
                "day_pvpower"
              ]
            }
          }
        },
        "required": [
          "month",
          "dailydata"
        ]
      },
      "description": "太陽光パネル出力量(各月の配列)"
    },
    "pcsInfo": {
      "type": "object",
      "properties": {
        "pcsConversion": {
          "type": "number",
          "description": "PCS変換効率"
        },
        "pcsOutput": {
          "type": "number",
          "description": "PCS出力値"
        }
      },
      "required": [
        "pcsConversion",
        "pcsOutput"
      ],
      "description": "PCSの情報"
    },
    "minPurchase": {
      "type": "number",
      "description": "最低買電量 (kW)"
    },
    "useCut2cell": {
      "type": "boolean",
      "description": "過積載充電を行う場合 true"
    },
    "noEp2cell": {
      "type": "boolean",
      "description": "系統からの蓄電池充電なしで太陽光を自家消費より蓄電池充電を優先させる場合 true"
    },
    "cellInfo": {
      "type": "object",
      "properties": {
        "actual_capacity": {
          "type": "number",
          "description": "実効容量(kWh)"
        },
        "charge_coeff": {
          "type": "number",
          "description": "充電変換効率(%)"
        },
        "charge_vol": {
          "type": "number",
          "description": "充電容量(kW)"
        },
        "discharge_coeff": {
          "type": "number",
          "description": "放電変換効率(%)"
        },
        "discharge_vol": {
          "type": "number",
          "description": "放電容量(kW)"
        },
        "peakLimit": {
          "type": "number",
          "description": "設定ピーク値(kW)"
        },
        "charge_from": {
          "type": "number",
          "description": "充電可能時間帯 From (系統から)"
        },
        "charge_to": {
          "type": "number",
          "description": "充電可能時間帯 To (系統から)"
        },
        "discharge_from": {
          "type": "number",
          "description": "放電可能時間帯 From"
        },
        "discharge_to": {
          "type": "number",
          "description": "放電可能時間帯 To"
        },
        "usePv2cell": {
          "type": "boolean",
          "description": "次の日の太陽光余剰からの蓄電を前提に、系統からの充電を抑える場合 true"
        }
      },
      "required": [
        "actual_capacity",
        "charge_coeff",
        "charge_vol",
        "discharge_coeff",
        "discharge_vol",
        "charge_from",
        "charge_to",
        "discharge_from",
        "discharge_to"
      ],
      "description": "蓄電池の情報"
    },
    "monthlySetting": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "months": {
            "description": "該当月のリスト (2桁の文字列で指定してください)\n\n`01` (string)"
          },
          "peakLimit": {
            "type": "number",
            "description": "設定ピーク値(kW)"
          },
          "charge_from": {
            "type": "number",
            "description": "充電可能時間帯 From (系統から)"
          },
          "charge_to": {
            "type": "number",
            "description": "充電可能時間帯 To (系統から)"
          },
          "discharge_from": {
            "type": "number",
            "description": "放電可能時間帯 From"
          },
          "discharge_to": {
            "type": "number",
            "description": "放電可能時間帯 To"
          },
          "usePv2cell": {
            "type": "boolean",
            "description": "次の日の太陽光余剰からの蓄電を前提に、系統からの充電を抑える場合 true"
          },
          "pv4cell": {
            "type": "boolean",
            "description": "系統からの蓄電池充電なしで太陽光を自家消費より蓄電池充電を優先させる場合 true"
          }
        },
        "required": [
          "months",
          "peakLimit",
          "charge_from",
          "charge_to",
          "discharge_from",
          "discharge_to"
        ]
      },
      "description": "特定月の充放電設定を変更する場合"
    }
  },
  "required": [
    "usepowers"
  ]
}
Response  200
HideShow
Body
[
  {
    "month": "2020-01",
    "usepower": 1,
    "purchase": 1,
    "pv2self": 1,
    "pv2cell": 1,
    "pv2sell": 1,
    "pvcutoff": 1,
    "cut2cell": 1,
    "ep2self": 1,
    "ep2cell": 1,
    "cell2self": 1,
    "peak_purchase": 1,
    "dailydata": [
      {
        "day": 1,
        "day_usepower": [
          0
        ],
        "day_purchase": [
          0
        ],
        "day_pv2self": [
          0
        ],
        "day_pv2cell": [
          0
        ],
        "day_pv2sell": [
          0
        ],
        "day_pvcutoff": [
          0
        ],
        "day_cut2cell": [
          0
        ],
        "day_ep2self": [
          0
        ],
        "day_ep2cell": [
          0
        ],
        "day_cell2self": [
          0
        ],
        "day_cellrest": [
          0
        ]
      }
    ]
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "month": {
        "type": "string",
        "description": "年月(YYYY-MM形式)"
      },
      "usepower": {
        "type": "number",
        "description": "電気使用量（月合計）"
      },
      "purchase": {
        "type": "number",
        "description": "買電量（月合計）"
      },
      "pv2self": {
        "type": "number",
        "description": "太陽光発電からの自家消費量（月合計）"
      },
      "pv2cell": {
        "type": "number",
        "description": "太陽光発電から蓄電池への充電量（月合計）"
      },
      "pv2sell": {
        "type": "number",
        "description": "太陽光発電の売電量（月合計）"
      },
      "pvcutoff": {
        "type": "number",
        "description": "太陽光発電過積載ロス分（月合計）"
      },
      "cut2cell": {
        "type": "number",
        "description": "太陽光発電過積載充電量（月合計）"
      },
      "ep2self": {
        "type": "number",
        "description": "系統からの自家消費量（月合計）"
      },
      "ep2cell": {
        "type": "number",
        "description": "系統からの充電量（月合計）"
      },
      "cell2self": {
        "type": "number",
        "description": "蓄電池からの自家消費量（月合計）"
      },
      "peak_purchase": {
        "type": "number",
        "description": "買電量ピーク値（月）"
      },
      "dailydata": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "day": {
              "type": "number",
              "description": "日"
            },
            "day_usepower": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 電気使用量（長さ24の配列 (0:00~23:00)）"
            },
            "day_purchase": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 買電量（長さ24の配列 (0:00~23:00)）"
            },
            "day_pv2self": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 太陽光発電からの自家消費量（長さ24の配列 (0:00~23:00)）"
            },
            "day_pv2cell": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 太陽光発電からの蓄電量（長さ24の配列 (0:00~23:00)）"
            },
            "day_pv2sell": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 太陽光発電余剰分（長さ24の配列 (0:00~23:00)）"
            },
            "day_pvcutoff": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 太陽光発電過積載ロス分（長さ24の配列 (0:00~23:00)）"
            },
            "day_cut2cell": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 太陽光発電過積載充電量（長さ24の配列 (0:00~23:00)）"
            },
            "day_ep2self": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 系統からの自家消費量（長さ24の配列 (0:00~23:00)）"
            },
            "day_ep2cell": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 系統からの充電量（長さ24の配列 (0:00~23:00)）"
            },
            "day_cell2self": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 蓄電池からの自家消費量（長さ24の配列 (0:00~23:00)）"
            },
            "day_cellrest": {
              "type": "array",
              "items": {
                "type": "number"
              },
              "description": "１日の各時間帯 蓄電池残量（長さ24の配列 (0:00~23:00)）"
            }
          }
        }
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

電気料金計算

電気料金計算
POST/epchargecalc/

料金プランと買電量により電気料金を計算します。 epowers のデータの範囲が１年以上の場合、エラーとなります。 epowersは 60分平均ですが、30分平均のピーク値を用いて基本料金を計算したい場合は年間の ピーク値を peak_purchaseに指定してください。

Example URI

POST https://api.enegaeru.com/biz/epchargecalc/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "ep_type": 0,
  "epcorp_cd": 1,
  "epplan_cd": 1,
  "base_cd": 1,
  "customplan_id": "E1234567890",
  "capacity": 400,
  "epowers": [
    {
      "month": "2020-01",
      "dailydata": [
        {
          "day": 1,
          "day_purchase": [
            20
          ]
        }
      ]
    }
  ],
  "peak_purchase": 300
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "ep_type": {
      "type": "number",
      "description": "種別（0:高圧/特別高圧, 1:低圧、無指定の場合 0）"
    },
    "epcorp_cd": {
      "type": "number",
      "description": "電気事業者コード -1の場合はカスタムプランを使用"
    },
    "epplan_cd": {
      "type": "number",
      "description": "料金プランコード（カスタムプラン以外は必須）"
    },
    "base_cd": {
      "type": "number",
      "description": "基本料金コード（低圧、カスタムプラン以外は必須）"
    },
    "customplan_id": {
      "type": "string",
      "description": "カスタムプランID（カスタムプランの場合は必須）"
    },
    "capacity": {
      "type": "number",
      "description": "契約容量"
    },
    "epowers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "month": {
            "type": "string",
            "description": "年月(YYYY-MM形式)"
          },
          "dailydata": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "day": {
                  "type": "number",
                  "description": "日"
                },
                "day_purchase": {
                  "type": "array",
                  "items": {
                    "type": "number"
                  },
                  "description": "１日の各時間使用量 (長さ24の配列 (0:00～23:00))"
                }
              },
              "required": [
                "day",
                "day_purchase"
              ]
            }
          }
        },
        "required": [
          "month",
          "dailydata"
        ]
      },
      "description": "各月の配列"
    },
    "peak_purchase": {
      "type": "number",
      "description": "年間のピーク値(整数)"
    }
  },
  "required": [
    "epcorp_cd",
    "epowers"
  ]
}
Response  200
HideShow
Body
{
  "epcorp_cd": 1,
  "epcorp_name": "北海道電力",
  "epplan_cd": 1,
  "customplan_id": "E1234567890",
  "plan_name": "6,000V 業務用電力（一般料金）",
  "base_cd": 1,
  "base_name": "6,000V 業務用電力（一般料金）容量500kW未満）",
  "yearcharge": 167080,
  "monthlycharges": [
    {
      "month": "2020-01",
      "charge": 14200,
      "base": 2000,
      "usage": 11000,
      "adjust": 200,
      "levy": 1000
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "epcorp_cd": {
      "type": "number",
      "description": "電気事業者コード"
    },
    "epcorp_name": {
      "type": "string",
      "description": "電気事業者名"
    },
    "epplan_cd": {
      "type": "number",
      "description": "料金プランコード"
    },
    "customplan_id": {
      "type": "string",
      "description": "カスタムプランID（独自プランの場合）"
    },
    "plan_name": {
      "type": "string",
      "description": "料金プラン名"
    },
    "base_cd": {
      "type": "number",
      "description": "基本料金コード"
    },
    "base_name": {
      "type": "string",
      "description": "基本料金名"
    },
    "yearcharge": {
      "type": "number",
      "description": "電気料金総額(年)"
    },
    "monthlycharges": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "month": {
            "type": "string",
            "description": "年月(YYYY-MM形式)"
          },
          "charge": {
            "type": "number",
            "description": "月電気料金"
          },
          "base": {
            "type": "number",
            "description": "基本料金"
          },
          "usage": {
            "type": "number",
            "description": "従量料金"
          },
          "adjust": {
            "type": "number",
            "description": "燃料調整費"
          },
          "levy": {
            "type": "number",
            "description": "再エネ賦課金"
          }
        }
      },
      "description": "各月の電気料金"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

マスター系

日射量観測地点

日射量観測地点取得
GET/sunpoints/{?prefecture_cd}

都道府県コードより日射量観測地点を取得します。
*都道府県コード
　　北海道　01:北海道
　　東北　　02:青森県, 03:岩手県, 04:宮城県, 05:秋田県, 06:山形県, 07:福島県
　　関東　　08:茨城県, 09:栃木県, 10:群馬県, 11:埼玉県, 12:千葉県, 13:東京都, 14:神奈川県
　　北陸　　15:新潟県, 16:富山県, 17:石川県, 18:福井県
　　中部　　19:山梨県, 20:長野県, 21:岐阜県, 22:静岡県, 23:愛知県
　　近畿　　24:三重県, 25:滋賀県, 26:京都府, 27:大阪府, 28:兵庫県, 29:奈良県, 30:和歌山県
　　中国　　31:鳥取県, 32:島根県, 33:岡山県, 34:広島県, 35:山口県
　　四国　　36:徳島県, 37:香川県, 38:愛媛県, 39:高知県
　　九州　　40:福岡県, 41:佐賀県, 42:長崎県, 43:熊本県, 44:大分県, 45:宮崎県, 46:鹿児島県
　　沖縄　　47:沖縄県

Example URI

GET https://api.enegaeru.com/biz/sunpoints/?prefecture_cd=13
URI Parameters
HideShow
prefecture_cd
string (optional) Example: 13

都道府県コード

Response  200
HideShow
Body
[
  {
    "point_no": 44134,
    "point_name": "東京",
    "pref_capital": 1,
    "prefecture_cd": "13"
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "point_no": {
        "type": "number",
        "description": "地点No."
      },
      "point_name": {
        "type": "string",
        "description": "設置場所."
      },
      "pref_capital": {
        "type": "number",
        "description": "県庁所在地フラグ (0:県庁所在地でない, 1:県庁所在地)"
      },
      "prefecture_cd": {
        "type": "string",
        "description": "都道府県コード"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

電気事業者

電気事業者取得
GET/epcorps{?prefecture_cd,zip_cd,area_cd,ep_type}

電気事業者の一覧を取得します。
（prefecture_cd, zip_cd, area_cd は同時に指定できません。）

*都道府県コード
　　北海道　01:北海道
　　東北　　02:青森県, 03:岩手県, 04:宮城県, 05:秋田県, 06:山形県, 07:福島県
　　関東　　08:茨城県, 09:栃木県, 10:群馬県, 11:埼玉県, 12:千葉県, 13:東京都, 14:神奈川県
　　北陸　　15:新潟県, 16:富山県, 17:石川県, 18:福井県
　　中部　　19:山梨県, 20:長野県, 21:岐阜県, 22:静岡県, 23:愛知県
　　近畿　　24:三重県, 25:滋賀県, 26:京都府, 27:大阪府, 28:兵庫県, 29:奈良県, 30:和歌山県
　　中国　　31:鳥取県, 32:島根県, 33:岡山県, 34:広島県, 35:山口県
　　四国　　36:徳島県, 37:香川県, 38:愛媛県, 39:高知県
　　九州　　40:福岡県, 41:佐賀県, 42:長崎県, 43:熊本県, 44:大分県, 45:宮崎県, 46:鹿児島県
　　沖縄　　47:沖縄県
*エリアコード
　　1:北海道電力管内
　　2:東北電力管内
　　3:東京電力エナジーパートナー管内
　　4:北陸電力管内
　　5:中部電力ミライズ管内
　　6:関西電力管内
　　7:中国電力管内　
　　8:四国電力管内　
　　9:九州電力管内
　　10:沖縄電力管内

Example URI

GET https://api.enegaeru.com/biz/epcorps?prefecture_cd=13&zip_cd=1000005&area_cd=1&ep_type=0
URI Parameters
HideShow
prefecture_cd
string (optional) Example: 13

都道府県コード(01～47)

zip_cd
string (optional) Example: 1000005

郵便番号(ハイフンなし, 7桁)

area_cd
string (optional) Example: 1

エリアコード

ep_type
number (optional) Example: 0

種別（0:特高/高圧, 1:低圧, 無指定の場合は 0として扱います)

Response  200
HideShow
Body
[
  {
    "id": "4",
    "epcorp_short_name": "東京電力エナジーパートナー",
    "selling_10kW_less": 19,
    "selling_10kW_over\"": 12,
    "selling_50kW_over": 11,
    "surplus_selling": 24,
    "selling_after_fit\"": 8,
    "occtoepcorp_cd'": "K003",
    "metiepcorp_cd'": "A0269",
    "area_cd'": "4",
    "ep_type": 0
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "電気事業者コード"
      },
      "epcorp_short_name": {
        "type": "string",
        "description": "電気事業者名"
      },
      "selling_10kW_less": {
        "type": "number",
        "description": "FIT期間内10kW未満売電単価（特高/高圧のみ）"
      },
      "selling_10kW_over\"": {
        "type": "number",
        "description": "FIT期間内10kW以上売電単価（特高/高圧のみ）"
      },
      "selling_50kW_over": {
        "type": "number",
        "description": "FIT期間内50kW以上250kW未満売電単価（特高/高圧のみ）"
      },
      "surplus_selling": {
        "type": "number",
        "description": "FIT期間内余剰売電単価（低圧のみ）"
      },
      "selling_after_fit\"": {
        "type": "number",
        "description": "FIT期間後売電単価"
      },
      "occtoepcorp_cd'": {
        "type": "string",
        "description": "広域機関登録電力事業者コード"
      },
      "metiepcorp_cd'": {
        "type": "string",
        "description": "広域機関登録電力事業者コード"
      },
      "area_cd'": {
        "type": "string",
        "description": "　 (string)  エリアコード"
      },
      "ep_type": {
        "type": "number",
        "description": "種別（0:特高/高圧, 1:低圧)"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

電気料金プラン

電気料金プラン取得
GET/epplans/{epcorp_cd}/{?contract_type}

電気事業者コードより電気料金プランを取得します。

Example URI

GET https://api.enegaeru.com/biz/epplans/1/?contract_type=0
URI Parameters
HideShow
epcorp_cd
number (required) Example: 1

電気事業者コード

contract_type
number (optional) Example: 0

契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力) (無指定の場合は 0:高圧)

Response  200
HideShow
Body
[
  {
    "epcorp_cd": 1,
    "epplan_cd": 1,
    "plan_name": "6,000V 業務用電力（一般料金）",
    "period_from": "2001-01-01",
    "period_to": "2999-12-31",
    "contract_type": 0,
    "base_info": [
      {
        "base_name": "6,000V 業務用電力（一般料金）容量500kW未満",
        "base_cd": 1,
        "base_type": 5,
        "capacity_from": 50,
        "capacity_to": 500
      }
    ]
  }
]
Schema
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "epcorp_cd": {
        "type": "number",
        "description": "電気事業者コード"
      },
      "epplan_cd": {
        "type": "number",
        "description": "料金プランコード"
      },
      "plan_name": {
        "type": "string",
        "description": "料金プラン名称"
      },
      "period_from": {
        "type": "string",
        "description": "有効期間 From"
      },
      "period_to": {
        "type": "string",
        "description": "有効期間 To"
      },
      "contract_type": {
        "type": "number",
        "description": "契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力)"
      },
      "base_info": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "base_name": {
              "type": "string",
              "description": "基本料金名称"
            },
            "base_cd": {
              "type": "number",
              "description": "基本料金コード"
            },
            "base_type": {
              "type": "number",
              "description": "基本料金計算方法 (2:契約容量方式, 5:ピーク電力容量方式)"
            },
            "capacity_from": {
              "type": "number",
              "description": "契約容量下限値 (以上) (単位:kW)"
            },
            "capacity_to": {
              "type": "number",
              "description": "契約容量上限値 (未満) (単位:kW) 容量制限なしの場合 0"
            }
          }
        },
        "description": "基本料金情報　契約容量のレンジ別"
      }
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

電気料金プラン詳細

電気料金プラン詳細取得
GET/epplans/{epcorp_cd}/{epplan_cd}/{base_cd}

電気事業者コード,料金プランコード、基本料金コードより電気料金プランの単価を含めた詳細情報を取得します。
（特高/高圧プランのみ対象）

Example URI

GET https://api.enegaeru.com/biz/epplans/1/2/3
URI Parameters
HideShow
epcorp_cd
number (required) Example: 1

電気事業者コード

epplan_cd
number (required) Example: 2

料金プランコード

base_cd
number (required) Example: 3

基本料金コード

Response  200
HideShow
Body
{
  "epcorp_name": "北海道電力",
  "base_name": "6,000V 業務用電力（時間帯別料金）容量500kW未満）",
  "base_unit": 1870,
  "base_type": 5,
  "contract_type": 1,
  "saturday_flg": 0,
  "sunday_flg": 1,
  "holiday_flg": 1,
  "period_from": "2001-01-01",
  "period_to": "2999-12-31",
  "capacity_from": 50,
  "capacity_to": 500,
  "volumes": [
    {
      "cond_name": "6,000V 業務用電力（時間帯別料金）昼間時間・平日（8～22時）",
      "calc_order": 1,
      "volume_from": 0,
      "volume_to": 0,
      "month_from": 1,
      "month_to": 12,
      "holiday_data": 0,
      "time_from": 0,
      "time_to": 0,
      "volume_unit": 19.88
    }
  ]
}
Schema
{
  "type": "object",
  "properties": {
    "epcorp_name": {
      "type": "string",
      "description": "基本料金名称"
    },
    "base_name": {
      "type": "string",
      "description": "基本料金名称"
    },
    "base_unit": {
      "type": "number",
      "description": "基本料金単価"
    },
    "base_type": {
      "type": "number",
      "description": "基本料金計算方法 (2:契約容量方式, 5:ピーク電力容量方式)"
    },
    "contract_type": {
      "type": "number",
      "description": "契約種別 (0:高圧, 1:特別高圧)"
    },
    "saturday_flg": {
      "type": "number",
      "description": "土曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "sunday_flg": {
      "type": "number",
      "description": "日曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "holiday_flg": {
      "type": "number",
      "description": "祝日 休日/平日判定 (0:平日, 1:休日)"
    },
    "period_from": {
      "type": "string",
      "description": "有効期間 From"
    },
    "period_to": {
      "type": "string",
      "description": "有効期間 To"
    },
    "capacity_from": {
      "type": "number",
      "description": "契約容量下限値(以上) (単位:kW)"
    },
    "capacity_to": {
      "type": "number",
      "description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
    },
    "volumes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "cond_name": {
            "type": "string",
            "description": "条件名"
          },
          "calc_order": {
            "type": "number",
            "description": "計算順番"
          },
          "volume_from": {
            "type": "number",
            "description": "使用量 From"
          },
          "volume_to": {
            "type": "number",
            "description": "使用量 To 制限なしの場合 0"
          },
          "month_from": {
            "type": "number",
            "description": "月 From"
          },
          "month_to": {
            "type": "number",
            "description": "月 To"
          },
          "holiday_data": {
            "type": "number",
            "description": "休日フラグ (0：区別無し 1：平日 2：休日)"
          },
          "time_from": {
            "type": "number",
            "description": "時間 From"
          },
          "time_to": {
            "type": "number",
            "description": "時間 To"
          },
          "volume_unit": {
            "type": "number",
            "description": "単価"
          }
        }
      },
      "description": "従量条件"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

カスタム電気プラン管理

カスタム電気プランリスト取得
GET/customepplans/{?corporation_id}

カスタム電気プラン情報（複数）を取得します。（システム管理者以外の場合は自身の企業のみ）

Example URI

GET https://api.enegaeru.com/biz/customepplans/?corporation_id=C1234567890
URI Parameters
HideShow
corporation_id
string (optional) Example: C1234567890

企業コード（システム管理者のみ指定可能）

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "id": "E1234567890",
    "name": "高圧テストプラン",
    "record_no": "E-01",
    "plan_info": "休日が安いプラン",
    "base_type": 5,
    "contract_type": 0,
    "area_cd": "1",
    "capacity_from": 50,
    "capacity_to": 500,
    "corporation_id": "C1234567890",
    "created_id": "user@example",
    "created": "2019-01-24T06:17:49.811Z",
    "modified_id": "user@example",
    "modified": "2019-01-24T06:17:49.811Z"
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "プランコード"
      },
      "name": {
        "type": "string",
        "description": "プラン名称"
      },
      "record_no": {
        "type": "string",
        "description": "レコード番号（ユーザーによる識別子）"
      },
      "plan_info": {
        "type": "string",
        "description": "プラン情報"
      },
      "base_type": {
        "type": "number",
        "description": "基本料金計算方法 (1:固定方式, 2:契約容量方式, 5:ピーク電力容量方式)"
      },
      "contract_type": {
        "type": "number",
        "description": "契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力)"
      },
      "area_cd": {
        "type": "string",
        "description": "エリアコード"
      },
      "capacity_from": {
        "type": "number",
        "description": "契約容量下限値(以上) (単位:kW) (0の場合は0)"
      },
      "capacity_to": {
        "type": "number",
        "description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
      },
      "corporation_id": {
        "type": "string",
        "description": "企業ID"
      },
      "created_id": {
        "type": "string",
        "description": "登録したユーザー名"
      },
      "created": {
        "type": "string",
        "description": "レコード作成日時"
      },
      "modified_id": {
        "type": "string",
        "description": "更新したユーザー名"
      },
      "modified": {
        "type": "string",
        "description": "レコード更新日時"
      }
    }
  }
}

カスタム電気プラン登録
POST/customepplans/

新規カスタム電気プランを登録します。

Example URI

POST https://api.enegaeru.com/biz/customepplans/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "6,000V 業務用電力 容量500kW未満）",
  "record_no": "E-01",
  "plan_info": "休日が安いプラン",
  "base_unit": 1870,
  "base_type": 5,
  "contract_type": 0,
  "saturday_flg": 0,
  "sunday_flg": 1,
  "holiday_flg": 1,
  "area_cd": "1",
  "capacity_from": 50,
  "capacity_to": 500,
  "fuels": [
    3.6
  ],
  "volumes": [
    {
      "calc_order": 1,
      "volume_from": 0,
      "volume_to": 0,
      "month_from": 1,
      "month_to": 12,
      "holiday_data": 0,
      "time_from": 0,
      "time_to": 0,
      "volume_unit": 19.88
    }
  ],
  "corporation_id": "C1234567890"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "プラン名称"
    },
    "record_no": {
      "type": "string",
      "description": "レコード番号（ユーザーによる識別子）"
    },
    "plan_info": {
      "type": "string",
      "description": "プラン情報"
    },
    "base_unit": {
      "type": "number",
      "description": "基本料金単価"
    },
    "base_type": {
      "type": "number",
      "description": "基本料金計算方法 (1:固定方式, 2:契約容量方式, 5:ピーク電力容量方式)"
    },
    "contract_type": {
      "type": "number",
      "description": "契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力)"
    },
    "saturday_flg": {
      "type": "number",
      "description": "土曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "sunday_flg": {
      "type": "number",
      "description": "日曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "holiday_flg": {
      "type": "number",
      "description": "祝日 休日/平日判定 (0:平日, 1:休日)"
    },
    "area_cd": {
      "type": "string",
      "description": "エリアコード"
    },
    "capacity_from": {
      "type": "number",
      "description": "契約容量下限値(以上) (単位:kW)"
    },
    "capacity_to": {
      "type": "number",
      "description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
    },
    "fuels": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "燃料調整費単価 (1月～12月) (個別の燃料調整費を適用する場合)"
    },
    "volumes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calc_order": {
            "type": "number",
            "description": "計算順番"
          },
          "volume_from": {
            "type": "number",
            "description": "使用量 From"
          },
          "volume_to": {
            "type": "number",
            "description": "使用量 To 制限なしの場合 0"
          },
          "month_from": {
            "type": "number",
            "description": "月 From"
          },
          "month_to": {
            "type": "number",
            "description": "月 To"
          },
          "holiday_data": {
            "type": "number",
            "description": "休日フラグ (0：区別無し 1：平日 2：休日)"
          },
          "time_from": {
            "type": "number",
            "description": "時間 From"
          },
          "time_to": {
            "type": "number",
            "description": "時間 To"
          },
          "volume_unit": {
            "type": "number",
            "description": "単価"
          }
        },
        "required": [
          "calc_order",
          "volume_from",
          "volume_to",
          "month_from",
          "month_to",
          "holiday_data",
          "time_from",
          "time_to",
          "volume_unit"
        ]
      },
      "description": "従量条件"
    },
    "corporation_id": {
      "type": "string",
      "description": "企業ID（システム管理者のみ指定可能）"
    }
  },
  "required": [
    "name",
    "base_unit",
    "base_type",
    "contract_type",
    "saturday_flg",
    "sunday_flg",
    "holiday_flg",
    "area_cd",
    "capacity_from",
    "capacity_to",
    "volumes"
  ]
}
Response  200
HideShow
Body
{
  "id": 0,
  "created": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "料金プランID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

個別カスタム電気プラン管理

電気料金詳細情報取得
GET/customepplans/{id}

料金プランコード、基本料金コードより電気料金プランの単価を含めた詳細情報を取得します。

Example URI

GET https://api.enegaeru.com/biz/customepplans/E1234567890
URI Parameters
HideShow
id
string (required) Example: E1234567890

料金プランID

Response  200
HideShow
Body
{
  "id": "E1234567890",
  "name": "6,000V 業務用電力 容量500kW未満）",
  "record_no": "E-01",
  "plan_info": "休日が安いプラン",
  "base_unit": 1870,
  "base_type": 5,
  "contract_type": 0,
  "saturday_flg": 0,
  "sunday_flg": 1,
  "holiday_flg": 1,
  "area_cd": "1",
  "capacity_from": 50,
  "capacity_to": 500,
  "fuels": [
    3.6
  ],
  "volumes": [
    {
      "calc_order": 1,
      "volume_from": 0,
      "volume_to": 0,
      "month_from": 1,
      "month_to": 12,
      "holiday_data": 0,
      "time_from": 0,
      "time_to": 0,
      "volume_unit": 19.88
    }
  ],
  "corporation_id": "C1234567890",
  "created_id": "user@example",
  "created": "2019-01-24T06:17:49.811Z",
  "modified_id": "user@example",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "料金プランID"
    },
    "name": {
      "type": "string",
      "description": "プラン名称"
    },
    "record_no": {
      "type": "string",
      "description": "レコード番号（ユーザーによる識別子）"
    },
    "plan_info": {
      "type": "string",
      "description": "プラン情報"
    },
    "base_unit": {
      "type": "number",
      "description": "基本料金単価"
    },
    "base_type": {
      "type": "number",
      "description": "基本料金計算方法 (1:固定方式, 2:契約容量方式, 5:ピーク電力容量方式)"
    },
    "contract_type": {
      "type": "number",
      "description": "契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力)"
    },
    "saturday_flg": {
      "type": "number",
      "description": "土曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "sunday_flg": {
      "type": "number",
      "description": "日曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "holiday_flg": {
      "type": "number",
      "description": "祝日 休日/平日判定 (0:平日, 1:休日)"
    },
    "area_cd": {
      "type": "string",
      "description": "エリアコード"
    },
    "capacity_from": {
      "type": "number",
      "description": "契約容量下限値(以上) (単位:kW)"
    },
    "capacity_to": {
      "type": "number",
      "description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
    },
    "fuels": {
      "type": "array",
      "items": {
        "type": "number",
        "description": "燃料調整費単価 (円/kWh)"
      },
      "description": "燃料調整費単価 (1月～12月) (fuel_cd = -1 の場合のみ)"
    },
    "volumes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calc_order": {
            "type": "number",
            "description": "計算順番"
          },
          "volume_from": {
            "type": "number",
            "description": "使用量 From"
          },
          "volume_to": {
            "type": "number",
            "description": "使用量 To 制限なしの場合 0"
          },
          "month_from": {
            "type": "number",
            "description": "月 From"
          },
          "month_to": {
            "type": "number",
            "description": "月 To"
          },
          "holiday_data": {
            "type": "number",
            "description": "休日フラグ (0：区別無し 1：平日 2：休日)"
          },
          "time_from": {
            "type": "number",
            "description": "時間 From"
          },
          "time_to": {
            "type": "number",
            "description": "時間 To"
          },
          "volume_unit": {
            "type": "number",
            "description": "単価"
          }
        }
      },
      "description": "従量条件"
    },
    "corporation_id": {
      "type": "string",
      "description": "企業ID"
    },
    "created_id": {
      "type": "string",
      "description": "登録したユーザーID"
    },
    "created": {
      "type": "string",
      "description": "レコード作成日時"
    },
    "modified_id": {
      "type": "string",
      "description": "更新したユーザーID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

カスタム電気プラン情報削除
DELETE/customepplans/{id}

指定したカスタム電気プランの登録情報を削除します。

Example URI

DELETE https://api.enegaeru.com/biz/customepplans/E1234567890
URI Parameters
HideShow
id
string (required) Example: E1234567890

料金プランID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "E1234567890",
  "deleted": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "料金プランID"
    },
    "deleted": {
      "type": "string",
      "description": "レコード削除日時"
    }
  }
}

カスタム電気プラン情報更新
PUT/customepplans/{id}

指定したカスタム電気プランの登録情報を更新します。

Example URI

PUT https://api.enegaeru.com/biz/customepplans/E1234567890
URI Parameters
HideShow
id
string (required) Example: E1234567890

料金プランID

Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "name": "6,000V 業務用電力 容量500kW未満）",
  "record_no": "E-01",
  "plan_info": "休日が安いプラン",
  "base_unit": 1870,
  "base_type": 5,
  "contract_type": 0,
  "saturday_flg": 0,
  "sunday_flg": 1,
  "holiday_flg": 1,
  "area_cd": "1",
  "capacity_from": 50,
  "capacity_to": 500,
  "fuels": [
    3.6
  ],
  "volumes": [
    {
      "calc_order": 1,
      "volume_from": 0,
      "volume_to": 0,
      "month_from": 1,
      "month_to": 12,
      "holiday_data": 0,
      "time_from": 0,
      "time_to": 0,
      "volume_unit": 19.88
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "プラン名称"
    },
    "record_no": {
      "type": "string",
      "description": "レコード番号（ユーザーによる識別子）"
    },
    "plan_info": {
      "type": "string",
      "description": "プラン情報"
    },
    "base_unit": {
      "type": "number",
      "description": "基本料金単価"
    },
    "base_type": {
      "type": "number",
      "description": "基本料金計算方法 (1:固定方式, 2:契約容量方式, 5:ピーク電力容量方式)"
    },
    "contract_type": {
      "type": "number",
      "description": "契約種別 (0:高圧, 1:特別高圧, 2:低圧電灯, 3:低圧電力)"
    },
    "saturday_flg": {
      "type": "number",
      "description": "土曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "sunday_flg": {
      "type": "number",
      "description": "日曜日 休日/平日判定 (0:平日, 1:休日)"
    },
    "holiday_flg": {
      "type": "number",
      "description": "祝日 休日/平日判定 (0:平日, 1:休日)"
    },
    "area_cd": {
      "type": "string",
      "description": "エリアコード"
    },
    "capacity_from": {
      "type": "number",
      "description": "契約容量下限値(以上) (単位:kW)"
    },
    "capacity_to": {
      "type": "number",
      "description": "契約容量上限値(未満) (単位:kW) 容量制限なしの場合 0"
    },
    "fuels": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "燃料調整費単価 (1月～12月) (個別の燃料調整費を適用する場合)"
    },
    "volumes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "calc_order": {
            "type": "number",
            "description": "計算順番"
          },
          "volume_from": {
            "type": "number",
            "description": "使用量 From"
          },
          "volume_to": {
            "type": "number",
            "description": "使用量 To 制限なしの場合 0"
          },
          "month_from": {
            "type": "number",
            "description": "月 From"
          },
          "month_to": {
            "type": "number",
            "description": "月 To"
          },
          "holiday_data": {
            "type": "number",
            "description": "休日フラグ (0：区別無し 1：平日 2：休日)"
          },
          "time_from": {
            "type": "number",
            "description": "時間 From"
          },
          "time_to": {
            "type": "number",
            "description": "時間 To"
          },
          "volume_unit": {
            "type": "number",
            "description": "単価"
          }
        }
      },
      "description": "従量条件"
    }
  }
}
Response  200
HideShow
Body
{
  "id": "E1234567890",
  "modified": "2019-01-24T06:17:49.811Z"
}
Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "料金プランID"
    },
    "modified": {
      "type": "string",
      "description": "レコード更新日時"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

その他

ログイン

ログイン
POST/login/

ユーザーIDとパスワードでシステムにログインします。

Example URI

POST https://api.enegaeru.com/biz/login/
Request  with body
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "user0000",
  "password": "Password",
  "forcelogin": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ユーザー名"
    },
    "password": {
      "type": "string",
      "description": "パスワード"
    },
    "forcelogin": {
      "type": "boolean",
      "description": "2重ログインの場合、強制的にログインするための指定（それ以前に同じユーザー名でログインしていた他の利用者は以降認証エラーとなります。）"
    }
  },
  "required": [
    "id",
    "password"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "uid": "AQxCxxgKnxxLLhxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "userinfo": {}
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "アクセストークン（API call時は Header の Authorization に この値をセットします）"
    },
    "userinfo": {
      "type": "object",
      "properties": {},
      "description": "ユーザーの情報（API利用時は通常使用しません）"
    }
  }
}

ログアウト

ログアウト
GET/logout/

システムからログアウトします。

Example URI

GET https://api.enegaeru.com/biz/logout/
Response  200
HideShow
Body
{
  "result": true
}
Schema
{
  "type": "object",
  "properties": {
    "result": {
      "type": "boolean",
      "description": "処理完了"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Generated by aglio on 10 Oct 2024