電力広域的運営推進機関システム
WebAPI 仕様書_概要

第 1.3 版
電力広域的運営推進機関
2019 年 8 月 30 日

改訂履歴版

年月日

改訂概要

1.0

2015/08/31 初版作成

1.1

2016/1/14 ■WebAPI 一覧
・ファイルフォーマット参照先の誤記修正「外部 IF_計画送信ステータス一覧」→「外部 IF_FIT ステータス一覧」
・ヘッダの誤記修正「Ver」→「BPID 版」「副機関」→「BPID 副機関コード」「メッセージ ID」→「情報区分コード」
・中分類の誤記修正「通告変更希望計画」→「通告変更」

1.2

2016/1/20 ■WebAPI 連携仕様
・1.1.連携仕様概要のリクエストパラメータの禁止文字に関する記述を削除

1.3

2019/8/30 ■WebAPI 連携仕様
・1.1.連携仕様概要の XML メッセージの仕様、及び、SSL クライアント認証の仕様に需要抑制計画の記述を追記■WebAPI 一覧
・混雑処理通知(スポット・1 時間前)取得を追加
・混雑処理通知(スポット・1 時間前)一覧取得を追加
・翌日需要抑制計画登録を追加
・週間需要抑制計画登録を追加
・月間需要抑制計画登録を追加
・年間需要抑制計画登録を追加
・翌日需要抑制計画不整合通知取得を追加
・翌日需要抑制計画不整合通知一覧取得を追加
・WebAPI 名を修正
「翌日連系線利用計画登録」→「経過措置計画登録」「翌日利用計画送電可否判定結果通知取得」→「経過措置可否判定結果通知取得」「翌日利用計画送電可否判定結果通知一覧取得」→「経過措置可否判定結果通知一覧取得」「混雑処理通知(翌日)取得」→「経過措置減少処理通知取得」「混雑処理通知(翌日)一覧取得」→「経過措置減少処理通知一覧取得」「混雑処理通知(通告変更)取得」→「混雑処理通知(スポット・1 時間前)(暫定)取得」「混雑処理通知(通告変更)一覧取得」→「混雑処理通知(スポット・1 時間前)(暫定)一覧取得」

1

備考

目次
NO

記載内容

ページ

1

WebAPI 連携仕様

32

WebAPI 連携手順

123

WebAPI 一覧

142

1. WebAPI 連携仕様
1.1. 連携仕様概要
WebAPI は、XML のメッセージを使用して情報連携を行うインタフェースである。
通信方式は HTTP を利用する。
各事業者アプリケーションから WebAPI を利用するためには、http のリクエストパラメータを設定してリクエストを送信する。
各 WebAPI のリクエストパラメータについては各 WebAPI仕様を参照のこと。
各 WebAPI はリクエストを受け付ける際にユーザ ID、パスワードにより認証を行うため、各事業者アプリケーションからの http リクエストパラメータにユーザ ID、パスワードを設定して連携を行う。また、SSL クライアント認証を行うため、リクエストを行う際は httpsにて連携を行う。
各事業者の 1 日の WebAPI 利用回数には上限を設けており、全体での上限回数を 1000 回とする。1 つの API を呼ぶ度に回数が 1 加算される為、API を呼んだ回数分加算される。
また、上限回数を超えた場合、「API 上限回数を超えています」というエラーコードを返す。
WebAPI は登録系、一覧取得系、ファイル取得系、その他で構成されている。
4 種類の概要については、1. 2 章～1.5 章に記載する。また、2.1 章に一覧取得系 API とファイル取得系 API の連携について記載する。
各 WebAPI の種類については、WebAPI 一覧を参照のこと。
XML メッセージの仕様、及び、SSL クライアント認証の仕様は、【発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編】、【発電計画等受領業務 EDI 共通規格】、【需要抑制計画等受領業務ビジネスプロトコル標準規格】に準拠する。

3

1.2. 登録系 API
登録系の API は、アプリケーション側から発電計画等を登録するためのものであり、リクエストのパラメータに発電計画等の XML メッセージを設定し、POST メソッドで送信する。
WebAPI では、受信した XML メッセージの内容チェック・登録などを行い、結果を返信する。

連携イメージを図 1.1 に示す。

図 1.1 登録系 API 連携4

1.3. 一覧取得系 API
一覧取得系の API は、送電可否判定結果通知等の結果通知ファイルの一覧を取得するためのものであり、リクエストのパラメータにユーザ ID を指定し、POST メソッドで送信する。
WebAPI では、広域機関より発行されている結果通知ファイルの一覧情報をレスポンスとして XML メッセージの ZIP 形式で返信する。

連携イメージを図 1.2 に示す。

図 1.2 一覧取得系 API 連携

5

1.4. ファイル取得系 API
ファイル取得系の API は、送電可否判定結果通知等の結果通知を取得するためのものであり、リクエストのパラメータに resultid を指定し、POST メソッドで送信する。
WebAPI では、リクエストで指定された resultid の結果通知をレスポンスとしてXML メッセージの ZIP 形式で返信する。
なお、resultid は 1.3 章の一覧取得系 API により取得して利用する。

連携イメージを図 1.3 に示す。

図 1.3 ファイル取得系 API 連携

6

1.5. その他 API
1.2 章～1.4 章の API 以外に補助的 API を用意している。
それらの概要について以下に記載する。

1.5.1. 業務一覧取得
事業者が利用可能な業務の一覧を取得する API。業務一覧の情報をレスポンスとしてXML メッセージの ZIP 形式で返信する。

連携イメージを図 1.4 に示す。

図 1.4 業務一覧取得

7

1.5.2. 受付ファイル一覧取得
1.2 章の登録系 API により提出した計画ファイルの一覧を取得する API。提出した計画ファイルのステータス一覧をレスポンスとして XML メッセージの ZIP 形式で返信する。

連携イメージを図 1.5 に示す。

図 1.5 受付ファイル一覧取得

8

1.5.3. 受信確認メッセージ取得
受付ファイル一覧取得により、取得したファイル一覧の中で、計画受付ステータスが、提出エラーとなっているものについて、エラーの内容を記したファイルを取得するための API。

連携イメージを図 1.6 受信確認メッセージ取得に示す。

図 1.6 受信確認メッセージ取得

9

1.5.4. 結果・通知ファイル一覧取得
結果通知すべてを取得したい場合に利用する API。（1.3 章の一覧取得系 API は結果通知の種類ごとに一覧を取得）

連携イメージを図 1.7 に示す。

図 1.7 結果・通知ファイル一覧取得

10

1.5.5. 受信確認メッセージ登録
1.4 章のファイル取得系 API により、ファイル取得後、各事業者側にてファイルの 3層チェック、4 層チェックを行った結果を広域機関に提出するための API。

連携イメージを図 1.8 に示す。

図 1.8 受信確認メッセージ登録11

2. WebAPI 連携手順
2.1. 一覧取得系 API とファイル取得系 API の連携手順
各結果通知を取得するためには、一覧取得系 API とファイル取得系 API を組み合わせた連携をする。
① 取得したい結果通知種類の一覧取得系 API を使用し、resultid を取得する。
② ①で取得した resultid をリクエストのパラメータとして設定し、ファイル取得系 API の呼び出しを行う。
③ レスポンスとして、resultid に該当する結果通知ファイルを取得する。

④ 結果通知ファイルを取得後、各事業者側システムにてファイルの構造チェック等を行い、チェック結果 OK の場合には ACK ファイル、チェック結果 NG の場合には ERR ファイルを受信確認メッセージ登録 API のリクエストのパラメータに設定して、広域機関に送信する。

連携イメージを図 2.1 に示す。

12

各事業者処理イメージ

広域機関 WebAPI処理イメージ

リクエスト
パラメータの作成

リクエストパラメータ（ユーザ ID）等

HTTP POST
メソッド
コール

レスポンス
処理

HTTP POST①

指定した結果・通知一覧作成

・認証機能
・マスタ系データ
・計画受付データなど

結果返信

リクエストパラメータ（resultid）※「一覧取得系 API」で取得したもの② HTTP POST

受信レスポンス
XML メッセージ（ZIP 形式）（結果・通知情報）
レスポンス
処理

関連機能/
関連データ

HTTP 200 OK

リクエストパラメータの作成
HTTP POST
メソッド
コール

レスポンス
XML メッセージ（ZIP 形式）（指定した結果・通知一覧情報）

受信③

結果・通知情報作成

結果返信

HTTP 200 OK

メッセージ
チェック
処理
受信確認
メッセージ
作成処理
HTTP POST
メソッド
コール

リクエストパラメータ(ZIP 形式)（受信確認メッセージ）④ HTTP POST

受信レスポンス
メッセージ
レスポンス
処理

受信確認メッセージ格
納
結果返信

HTTP 200 OK

図 2.1 一覧取得系 API とファイル取得系 API の連携手順

13

WebAPI一覧
ビジネスプロトコル
No

大分類

処理種別

WebAPI名

中分類

種類
BPID版

BPID副機関コード

APIID

ファイルフォーマット参照先

情報区分コード

受付 結果
登録 通知

1

業務一覧取得---その他

BA11B002

WebAPI仕様書 外部IF_業務一覧参照

-

○

2

受付ファイル一覧取得

--

-

その他

BA11B005

WebAPI仕様書 外部IF_計画受信ステータス一覧参照-○

受信確認メッセージ取得

--

-

その他

BA11B006

発電計画等受領業務ビジネスプロトコル通信手順
及び受信確認メッセージ標準規格
5を参照

-

○

4

結果・通知ファイル一覧取得

--

-

その他

BA11B007

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

5

受信確認メッセージ登録

--

-

その他

BA11B009

発電計画等受領業務ビジネスプロトコル通信手順
及び受信確認メッセージ標準規格
5.3.2を参照○-

6

翌日発電・販売計画登録

3A

W60150

登録系

BA11B101○-

7

週間発電・販売計画登録

3A

W60160

登録系

BA11B102○-8

月間発電・販売計画登録

3A

W60170

登録系

BA11B103○-9

年間発電・販売計画登録

3A

W60180

登録系

BA11B104○-10

翌日需要・調達計画登録

3A

W60250

登録系

BA11B109○-

週間需要・調達計画登録

3A

W60260

登録系

BA11B110○-12

月間需要・調達計画登録

3A

W60270

登録系

BA11B111○-13

年間需要・調達計画登録

3A

W60280

登録系

BA11B112○-14

連系線希望計画登録(計画値同時同量)

3A

W60320

登録系

BA11B113○-

経過措置計画登録(計画値同時同量)

3A

W60460

登録系

BA11B114○-

3
共通

発電・販売計画11
需要・調達計画

連系線希望計画

15

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.1を参照発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.2を参照発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.3を参照発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.4を参照連系線利用計画16

長期連系線利用計画登録(計画値同時同量)

3A

W60400

登録系

BA11B118○-17

部分供給通告値(翌日)3A

W60610

登録系

BA11B119○-

部分供給通告値(月間)3A

W60620

登録系

BA11B121

部分供給
18

翌日発電・販売計画(FIT作成用)

19

20

22

○-

○

-

翌日発電・販売計画(FIT作成用)登録

3A

W60152

登録系

BA11B223

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.1を参照希望計画送電可否判定結果通知取得(計画値同時同量)

3A

W60321

ファイル取得系

BA11B123

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）3.5.1を参照-○

希望計画送電可否判定結果通知一覧取得(計画値同時同量)

3A

W60321

一覧取得系

BA11B124

WebAPI仕様書 外部IF_計画送信ステータス一覧参照-○

通告変更可否判定結果通知取得(計画値同時同量)

3A

W60462

ファイル取得系

BA11B127--○

通告変更可否判定結果通知一覧取得(計画値同時同量)

3A

W60462

一覧取得系

BA11B128

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

-

○

連系線希望計画
21

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.6.1を参照

通告変更
23

24

経過措置可否判定結果通知取得(計画値同時同量)

3A

W60461

ファイル取得系

BA11B125

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.5.2.2を参照

25

経過措置可否判定結果通知一覧取得(計画値同時同量)

3A

W60461

一覧取得系

BA11B126

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

26

週間利用計画送電可否判定結果通知取得(計画値同時同量)

3A

W60471

ファイル取得系

BA11B129

-

-

○

27

週間利用計画送電可否判定結果通知一覧取得(計画値同時同量)

3A

W60471

一覧取得系

BA11B130

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

28

月間利用計画送電可否判定結果通知取得(計画値同時同量)

3A

W60481

ファイル取得系

BA11B133

-

-

○

29

月間利用計画送電可否判定結果通知一覧取得(計画値同時同量)

3A

W60481

一覧取得系

BA11B134

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

30

年間利用計画送電可否判定結果通知取得(計画値同時同量)

3A

W60491

ファイル取得系

BA11B137--○

年間利用計画送電可否判定結果通知一覧取得(計画値同時同量)

3A

W60491

一覧取得系

BA11B138

WebAPI仕様書 外部IF_計画送信ステータス一覧参照-○

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.5.2.1を参照-○

連系線利用計画

発電計画
31

32

長期利用計画送電可否判定結果通知取得(計画値同時同量)

3A

W60401

ファイル取得系

BA11B14133

長期利用計画送電可否判定結果通知一覧取得(計画値同時同量)

3A

W60401

一覧取得系

BA11B142

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

34

経過措置減少処理通知取得(計画値同時同量)

3A

W60513

ファイル取得系

BA11B145

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.5.2.3を参照

-

○

35

経過措置減少処理通知一覧取得(計画値同時同量)

3A

W60513

一覧取得系

BA11B146

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

36

混雑処理通知(スポット・1時間前)(暫定)取得(計画値同時同量)

3A

W60514

ファイル取得系

BA11B147

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.5.2.3を参照

-

○

37

混雑処理通知(スポット・1時間前)(暫定)一覧取得(計画値同時同量)

3A

W60514

一覧取得系

BA11B148

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

38

混雑処理通知(スポット・1時間前)取得(計画値同時同量)

3A

W60515

ファイル取得系

BA11B240

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.5.2.4を参照

-

○

39

混雑処理通知(スポット・1時間前)一覧取得(計画値同時同量)

3A

W60515

一覧取得系

BA11B241

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

40

混雑処理通知(週間)取得(計画値同時同量)

3A

W60522

ファイル取得系

BA11B149

-

-

○

41

混雑処理通知(週間)一覧取得(計画値同時同量)

3A

W60522

一覧取得系

BA11B150

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

42

混雑処理通知(月間)取得(計画値同時同量)

3A

W60532

ファイル取得系

BA11B151

--

○

43

混雑処理通知(月間)一覧取得(計画値同時同量)

3A

W60532

一覧取得系

BA11B152

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

44

混雑処理通知(年間)取得(計画値同時同量)

3A

W60542

ファイル取得系

BA11B153

--

○

45

混雑処理通知(年間)一覧取得(計画値同時同量)

3A

W60542

一覧取得系

BA11B154

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

混雑処理

14

WebAPI一覧
ビジネスプロトコル
No

大分類

中分類

処理種別

WebAPI名

種類
BPID版

BPID副機関コード

APIID

ファイルフォーマット参照先

情報区分コード

受付 結果
登録 通知

46

混雑処理通知(長期)取得(計画値同時同量)

3A

W60552

ファイル取得系

BA11B155--○47

混雑処理通知(長期)一覧取得(計画値同時同量)

3A

W60552

一覧取得系

BA11B156

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○-

○

48

翌日発電・販売計画(FIT作成用)

49

50

51

翌日発電・販売計画(FIT作成用)取得

3A

W60152

ファイル取得系

BA11B225

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.1を参照翌日発電・販売計画(FIT作成用)一覧取得

3A

W60152

一覧取得系

BA11B224

WebAPI仕様書 外部IF_FITステータス一覧参照

-

○-

○

翌日発電・販売計画不整合通知取得

3A

W60151

ファイル取得系

BA11B228

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.1を参照翌日発電・販売計画不整合通知一覧取得

3A

W60151

一覧取得系

BA11B229

WebAPI仕様書 外部IF_計画送信ステータス一覧参照-○

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）3.2を参照-○

翌日発電・販売計画(不整合通知)52

翌日需要・調達計画不整合通知取得

3A

W60251

ファイル取得系

BA11B23053

翌日需要・調達計画不整合通知一覧取得

3A

W60251

一覧取得系

BA11B231

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

-

○

-

○

54

連系線利用計画(不整合通知)翌日連系線利用計画取得(計画値同時同量)

3A

W60460

ファイル取得系

BA11B232

発電計画等受領業務 ビジネスプロトコル標準規格（計画値同時同量編）
3.4を参照WebAPI仕様書 外部IF_計画送信ステータス一覧参照

55

翌日連系線利用計画一覧取得(計画値同時同量)

3A

W60460

一覧取得系

BA11B233-○

56

翌日需要抑制計画登録

3A

W80110

登録系

BA11B234○-57

週間需要抑制計画登録

3A

W80120

登録系

BA11B235○-58

月間需要抑制計画登録

3A

W80130

登録系

BA11B236○-59 需要抑制計画等

年間需要抑制計画登録

3A

W80140

登録系

BA11B237○--○-○

需要抑制計画60

61

需要抑制計画(不整合通知)需要抑制計画等受領業務ビジネスプロトコル標準規格
3.1を参照翌日需要抑制計画不整合通知取得

3A

W80111

ファイル取得系

BA11B238

需要抑制計画等受領業務ビジネスプロトコル標準規格
3.1を参照翌日需要抑制計画不整合通知一覧取得

3A

W80111

一覧取得系

BA11B239

WebAPI仕様書 外部IF_計画送信ステータス一覧参照

15