HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U...

109
Copyright(c) 2014 KDDI HEMS情報基盤 サービス事業者向け API仕様書 第2.2版 (仕様検討途中) 2015.6.2 KDDI株式会社

Transcript of HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U...

Page 1: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

HEMS 情報基盤

サービス事業者向け

API 仕様書

第 2.2 版

(仕様検討途中)

2015.6.2

KDDI 株式会社

Page 2: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

i C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

目次 はじめに ...................................................................... 1 目的と範囲 .................................................................... 1 参照ドキュメント .............................................................. 1 用語・略語の定義 .............................................................. 2 ID の定義 ...................................................................... 3 1. HEMS 情報基盤提供 API ................................................... 4 1.1 概要 .................................................................. 4 1.2 サービス連携標準 API の準拠状況について ................................. 4 1.3 REST 形式インタフェース ................................................ 5 1.3.1 ベース URL ........................................................... 5 1.3.2 リクエストフォーマット ............................................... 6 1.3.3 レスポンスフォーマット ............................................... 6 1.3.4 エラーレスポンス ..................................................... 8 1.3.5 エラーコード......................................................... 9 1.3.6 日付と時刻.......................................................... 10 1.3.7 リスト形式.......................................................... 11 1.3.8 サマリ形式.......................................................... 15 1.3.9 リスト形式、サマリ形式を提供する API ................................ 18 1.3.10 クエリストリングの URL エンコード ................................... 18 1.4 セキュリティ.......................................................... 20 1.4.1 通信の暗号化........................................................ 20 1.4.2 認証方式 ........................................................... 20 1.5 REST リソース ......................................................... 20 1.6 提供 API 詳細.......................................................... 22 1.6.1 HEMS 利用者(HemsUsers) .............................................. 22 1.6.2 収集データ(CollectData) ............................................. 34 1.6.3 サービス連携(ServiceConnections) .................................... 46 1.6.4 認証トークン(Authentication) ........................................ 52 1.6.5 状態種別分析情報(HemsAnalyses) ...................................... 55 1.6.6 属性種別分析情報(HemsStatic) ........................................ 58 1.6.7 イベント種別分析情報(HemsEvents) .................................... 63 1.6.8 電力データ平均値情報(CollectDataAvg) ................................ 66

Page 3: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

ii C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.9 節電アドバイス(SavingAdvice) ........................................ 69 1.6.10 家電(HemsControl) ※TBD ............................................ 76 1.6.11 コンテンツ(HemsContents) ※TBD ..................................... 77 1.6.12 メール(Mail) ....................................................... 80 1.6.13 グローバル IP アドレス(GlobalIpAddresses) ........................... 82 1.6.14 天気予報一覧(3時間値)取得(Weather) .............................. 86 2. 情報基盤コールバック API .............................................. 90 2.1 概要 ................................................................. 90 2.1.1 コールバック URL 形式 ................................................ 90 2.1.2 HTTP リクエストメソッド ............................................. 90 2.1.3 HTTP リクエストボディフォーマット ................................... 90 2.1.4 HTTP ステータスコード ............................................... 91 2.1.5 通信の暗号化........................................................ 91 2.1.6 認証方式 ........................................................... 91 2.1.7 エラー時の再送処理について .......................................... 92 2.2 コールバック API 詳細 .................................................. 93 2.2.1 HEMS 利用者状態変更通知 ............................................. 93 参考 1. REST リソースの想定用途 ................................................ 95 A.認証トークン要求~API 起動 .................................................. 95 B.HEMS 利用者情報変更通知(サービス契約)~サービス状態変更 ................... 96 C.HEMS 利用者情報変更通知(サービス解約)~サービス状態変更 ................... 97 D.HEMS 利用者情報変更通知(情報基盤解約)~サービス状態変更 ................... 98 E.HEMS 利用者情報変更通知(需要家属性)~変更反映 ............................. 99 参考 2. HEMS 重点 8機種からの収集プロパティ ................................... 100

Page 4: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

iii C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

変更履歴 日付 版 内容 2014/10/22 1.0 ベースライン登録 2015/1/30 1.7 ●1.6.14(1) 天気予報一覧取得 新規追加 2015/2/10 1.8 ●全ての API の入力パラメータの説明について、URI指定と要求プロパティ(リクエストボディ)の指定を追記 ●以下 API にリクエスト例を追記 ・1.6.1(1) HEMS 利用者取得(インスタンスリソース取得) ・1.6.2(1) 収集データ取得(HEMS 利用者単位) ・1.6.5(1) 状態種別取得 ・1.6.6(1) 世帯属性種別取得 ・1.6.7(1) イベント種別取得 ・1.6.8(1) 電力データ平均値取得 ・1.6.9(1) 節電アドバイス取得 ・1.6.9(2) 節電アドバイス一覧取得 ・1.6.12(1) メール送信 ・1.6.13(1) グローバル IP アドレス取得 ・1.6.13(2) グローバル IP アドレス一覧取得 ・1.6.14(1) 天気予報一覧 ●1.6.2(1) 収集データ取得(HEMS 利用者単位) フィルタリング条件(2.データ蓄積期間指定)のリクエストパラメータの例が誤っているのを修正(startCreateTime) ●1.6.2(2) 収集データ取得(HEMS 利用者単位) フィルタリング条件の説明を収集データ取得(HEMS 利用者単位)のきさいに合わせて修正 ●1.6.3(1) サービス利用者状態変更 要求プロパティに XML の場合に指定する集合項目を追記。 出力プロパティに集合項目「StatusUpdateResult」を追記。 XML のレスポンス例の誤記を修正。 ●1.6.4(1) 認証トークン要求 要求プロパティ「Authentication」の説明に「(XML 形式の場合に指定)」を追記 ●1.6.8(1) 電力データ平均値取得 要求プロパティに集合項目「CollectDataAvg」を追記

Page 5: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

iv C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

●1.6.9(2) 節電アドバイス一覧取得 詳細が決定したことにより以下を修正 ・入力パラメータにリスト形式取得についての文言追記 ・節電アドバイス一覧取得の出力プロパティを修正 ・節電アドバイス一覧取得のレスポンス例を修正 ●1.6.12(1) メール送信 要求プロパティに集合項目「Mail」を追記 ●1.6.14(1) 天気予報一覧取得 返却する天気画像番号の一覧を追記 2015/2/12 1.9 ●変更履歴の追加 ●1.3.5 エラーコード 新規追加 ●1.3.7 リスト形式について ・NextPageUri,PreviousPageUri の説明に返却されないケースがある旨を追記 ●1.3.9 リスト形式、サマリ形式を提供する API 新規追加 ●1.6.2 収集データリソースのインターフェース変更。並びに、URI を ver1.1 へ改版 (1) リストリソース取得(HEMS 利用者単位) (2) リストリソース取得(全体) ●1.6.2 収集データリソース (3)収集データに関する留意事項(積算電力量の単位)を修正 2015/2/25 2.0 ●1.6.1 (1) HEMS 利用者 ・出力プロパティ Latitude/ Longitude の説明に小数点以下の精度を追記 ●1.6.8 (1) 電力データ平均値取得 ・入力プロパティ EndTimestampの説明に"未満"で検索するよう追記 ・出力プロパティ CollectDataAvg の説明から「(XML の場合のみ返却)」を削除 ・出力プロパティ AvgValue の説明に小数点以下の精度を追記 ・レスポンス例[JSON の場合]に CollectDataAvg 集合項目を追記 ●1.6.14 (1) 天気予報一覧(3時間値)取得 ・レスポンス例[JSON の場合]およびレスポンス例[XML の場

Page 6: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

v C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

合]の返却項目 Prod を Prob に変更 ●2.2.1 (1) 天気予報一覧(3時間値)取得 ・要求プロパティの status について"Update"の説明文を変更 2015/3/20 2.1 ●1.3.10 クエリストリングの URL エンコード ・新規記載 ●1.6.1 (1) HEMS 利用者、(2)リストリソース取得、(3) リストリソース取得(サマリ取得) ・出力プロパティに ServiceConnectionId を追加。伴いレスポンス例に ServiceConnectionId を追記。 ●2.1.6 認証方式 ・コールバック API 用認証トークンの生成方法について詳細を記載。 ●巻末 参考 1 ・C.HEMS 利用者変更通知(サービス解約)~サービス状態変更の記載追加 ・D.HEMS 利用者変更通知(情報基盤解約)~サービス状態変更の記載追加 2015/6/2 2.2 ●1.3.7 リスト形式 ・ItemsPerPage のデフォルト値、最大値について記載 ●1.6.3 (3) サービス連携 ID取得(需要家ポータル ID) ・新規記載

Page 7: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

1 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

はじめに 本書は、情報基盤との連携においてサービス事業者に提供するインターフェースを規定します。 目的と範囲 「サービス事業者向け API」は、サービス事業者が HEMS 情報基盤を利用するためのインターフェース群で、以下の3つの API群によって構成されます。 ・サービス連携標準 API 準拠の API群 ・サービス連携標準 API 準拠以外の API群 ・サービス事業者向け状態変更通知 API群 参照ドキュメント ・「ECHONET Lite 規格書 Ver.1.11(日本語版)」 ・「APPENDIX ECHONET 機器オブジェクト詳細規定 Release E」 ・「HEMS-スマートメーター(Bルート)運用ガイドライン[第 1.0 版](案)」 ・「HEMS-太陽光発電 運用ガイドライン [第 1.1 版] 」 ・「HEMS-蓄電池 運用ガイドライン [第 1.1 版]」 ・「HEMS-EV/PHV電気自動車用充放電器 運用ガイドライン [第 1.1 版]」 ・「HEMS-燃料電池、ガス・石油給湯器 運用ガイドライン [第 1.1 版]」 ・「HEMS-照明機器 運用ガイドライン [第 1.1 版]」 ・「HEMS-エアコン 運用ガイドライン [第 1.1 版]」 ・「HEMS-HP給湯器 運用ガイドライン [第 1.1 版]」 ・「サービス連携標準 API仕様書 第 0.9 版 20141009」

Page 8: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

2 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

用語・略語の定義 用語・略語 定義 ECHONET Lite エコーネットコンソーシアムが策定した通信プロトコルで、ECHONET Lite フレーム(または、ECHONET Lite 電文)と呼ばれるメッセージをやり取りする通信手順である。個別通信または一斉同報通信を用いてECHONET Lite フレームを送受信する。ECHONET Lite フレームは、ヘッダ(EHD)、トランザクション ID(TID)と、送信元オブジェクト(SEOJ)、送信先オブジェクト(DEOJ)、アクセスルールを指定するサービス(ESV)、アクセス先プロパティ(EPC)、アクセス先プロパティ値(EDT)などから構成される。 サービス事業者 アグリゲータから取得する HEMS データを利活用し、サービスを提供する事業者を指す。 アグリゲータ HEMS 情報基盤を運営する事業者を指す。 HEMS 情報基盤 HEMS よりデータを収集し、収集したデータを、サービス事業者向け APIを用いてサービス事業者のシステムへ提供するための基盤。 HEMS 利用者 HEMS を自宅に設置し、サービスの提供を受ける人を指す。HEMS 利用者宅には HEMS 機器、B ルート対応スマート電力量メータ、ECHONET Lite 機器などが設置される。HEMS 機器はスマート電力量メータや ECHONET Lite機器などの情報を取得し、HEMS 事業者にデータを通知する。 JSON RFC4627 にて規定されるデータ記述言語。JavaScript Object Notationの略。 REST 2000 年に Roy Fielding 氏が提唱した、分散システムにおいて複数のソフトウェアを連携させるのに適した設計原則の集合。REST の設計原則は4 項目から成る。①セッションなどの状態管理を行わない。②情報を操作する命令の体系が予め定義・共有されている。③全ての情報は汎用的な構文で一意に識別される。④情報の内部に別の情報や状態へのリンクを含めることができる。 XML eXtensive Markup Language の略。 データの意味や構造を記述するためのマークアップ言語の一つ。マークアップ言語とは、「タグ」と呼ばれる特定の文字列で地の文に情報の意味や構造、装飾などを埋め込んでいく言語のことで、XML は独自のタグを指定できる。 HEMS 重点 8 機種 ECHONET 機器オブジェクト詳細規定における以下の 9 クラスを指す。 ①スマート電力量メータ(0x0288)、②住宅用太陽光発電(0x0279) ③蓄電池(0x027D)、④燃料電池(0x027C)、⑤電気自動車充放電器(0x027E) ⑥家庭用エアコン(0x0130)、⑦一般照明(0x0290)、⑧電気温水器(0x026B)、⑨瞬間式給湯器(0x0272)

Page 9: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

3 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

ID の定義 ID名 フォーマット 説明 生成契機 ServiceConnectionId (サービス連携 ID) 32桁英数字 サービス契約を識別するID です。HEMS データ利活用事業者が情報基盤上の契約ユーザ特定に用います。 なお、HEMS 管理事業者がHEMS 利用者に払いだす IDとは異なります。 HEMS 利用者のサービス契約時に情報基盤が生成します。 HemsUserId (サービス連携 ID) ServiceId (サービス識別 ID) 3 桁英数字 サービサーが提供するサービスを区別するためのID です。 情報基盤へのサービス登録時に情報基盤が生成します。

Page 10: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

4 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1. HEMS 情報基盤提供 API

1.1 概要 HEMS 情報基盤が提供する API は、以下の2つの API群で構成されます。 ① サービス連携標準 API 準拠の API群 ② サービス連携標準 API 準拠以外の API群 「サービス連携標準 API 準拠の API群」は、HEMS 利用者の属性データ、HEMS 利用者の HEMS データの提供を行う API を提供します。 「サービス連携標準 API 準拠以外の API群」は、HEMS匿名データ、HEMS 分析データの提供を行う API と HEMS表示端末向けコンテンツ操作 API を提供します。 1.2 サービス連携標準 API の準拠状況について サービス連携標準 API と、本 API仕様書との対応関係を以下に示す。 No REST リソース サービス連携標準 API 仕様書 第 x.x 版 201xmmdd 本 API 仕様書 対応 1 アカウント 2.1 アカウント - 2 サービス 2.2 サービス - 3 サービス連携 2.3 サービス連携 - 4 HEMS 利用者 2.4 HEMS 利用者 1.6.1 HEMS 利用者 5 収集データ 2.5 収集データ 1.6.2 収集データ 6 デバイス 2.6 デバイス - 7 アクセスログ 2.7 アクセスログ -

Page 11: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

5 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.3 REST 形式インタフェース サービス事業者向け API は REST 形式の呼び出しインタフェースを提供します。 1.3.1 ベース URL 1.3.1.1 サービス連携標準 API 準拠の API群 サービス事業者向け API のうちサービス連携標準 API 準拠にて提供する REST API のベース URL は以下の形式とします。 https://{ドメイン}/hemscommon/{リリースバージョン} ・商用ドメイン:api.hems.kddi.ne.jp ・検証ドメイン:dev.api.hems.kddi.ne.jp URL のサンプルは次の通りです。 商用ドメイン、リリースバージョンが ver1.0 の場合 https://api.hems.kddi.ne.jp/hemscommon/ver1.0 1.3.1.2 サービス連携標準 API 準拠以外の API群 サービス事業者向け API のうちサービス連携標準 API 準拠以外で提供する REST APIのベース URL は以下の形式とします。 https://{ドメイン}/{提供サービス名}/{リリースバージョン} ・商用ドメイン:api.hems.kddi.ne.jp ・検証ドメイン:dev.api.hems.kddi.ne.jp URL のサンプルは次の通りです。 商用ドメイン、リリースバージョンが ver1.0 の場合 https://api.hems.kddi.ne.jp/hemsoption/ver1.0

Page 12: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

6 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.3.2 リクエストフォーマット サービス事業者向け API に対する全てのリクエストは発行者の本人性を HTTPヘッダに載せる認証トークン (セキュリティコード)により伝達する必要があります。認証トークンは半角英数字 32桁の文字列です。 認証トークンを記述するヘッダ名は次の通りです。 X-Authentication-token: xxxxxxxxxxxxxxxx リクエストは GET、POST、PUT、DELTE に対応しています。API毎の対応メソッドは各API の説明(「1.6 提供 API 詳細」)を参照してください。 リクエスト例(リクエスト行) GET /hemsoption/ver1.0/HemsContents.json HTTP/1.1 リクエスト例(ヘッダ部) X-Authentication-token: xxxxxxxxxxxxxxxx リクエスト例(ボディ部) (ボディは無し) 1.3.3 レスポンスフォーマット HEMS 情報基盤は JSON、XML フォーマットでレスポンスを返却します。 リクエスト時の拡張子(.json/.xml)により、フォーマットを指定します。 全ての形式はエンコードが UTF-8、BOM無しとなります。 プロパティ値が省略される場合プロパティ自体がレスポンスに含まれません。 改行について、本書でサンプルを記載する際は、可読性を考慮し改行をし、インデントを付与しますが、実際には改行は行わず、インデントもありません。 また、JSON のオブジェクトおよびリスト内のプロパティ、XML の要素は全て順序不同となります。

Page 13: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

7 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

HTTP レスポンスの HTTP ステータスコードは以下の通りです。 •200 OK:リクエストが成功し、レスポンスボディーに要求した表現が含まれています。 •302 FOUND:リダイレクトレスポンスです。 •304 NOT MODIFIED: クライアントが保持しているキャッシュは、最新の状態です。 •400 BAD REQUEST:リクエストされた形式が正しくありません。 •401 UNAUTHORIZED:送信されたクレデンシャルでは、リソースにアクセスできません。 •404 NOT FOUND:リソースが存在しません。 •429 TOO MANY REQUESTS:同時に発行するリクエストの数が多すぎます。 •500 SERVER ERROR:内部サーバーエラーのため、レスポンスできません。 •503 SERVICE UNAVAILABLE:一時的にレスポンスできません。再試行してください。 レスポンス例[JSON の場合](ステータスライン、ヘッダ部の一部) HTTP/1.1 200 OK Content-Length: xx Content-Type: application/json; charset=utf-8 ・ レスポンス例[JSON の場合](ボディ部) { "HemsContents": { "HemsContentsId": "000001", "DateCreated": "2014-12-31T01:16:24+09:00", "DateUpdated": "2014-12-31T01:16:24+09:00", (略) "Uri": "\/hemsoption\/ver1.0\/HemsContents\/000001.json" } } レスポンス例[XML の場合](ステータスライン、ヘッダ部の一部) HTTP/1.1 200 OK Content-Length: xx Content-Type: application/xml; charset=utf-8 ・

Page 14: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

8 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

レスポンス例[XML の場合](ボディ部) <?xml version="1.0" encoding="utf-8" ?> <HemsContents> <HemsContentsId>000001</HemsContentsId> <DateCreated>2014-12-31T01:16:24+09:00</DateCreated> <DateUpdated>2014-12-31T01:16:24+09:00</DateUpdated> (略) <Uri>/hemsoption/ver1.0/HemsContents/000001.xml</Uri> </HemsContents> 1.3.4 エラーレスポンス エラー発生時は、以下のプロパティを出力します。 プロパティ 説明 Exception Status と ErrorCode、Message の 3 つのプロパティを含みます。 Status このエラーの HTTP ステータスコードです。 ErrorCode このエラーを識別するためのコードです。 0001 から~9999 までの数値となります。 Message このエラーを説明するメッセージです。 レスポンス例[JSON の場合](ステータスライン、ヘッダ部の一部) HTTP/1.1 404 Not Found Content-Length: xx Content-Type: application/json; charset=utf-8 ・ レスポンス例[JSON の場合](ボディ部) { "Exception ":{ "Status": "404", "ErrorCode":"2002", "Message": "The requested resource was not found" } }

Page 15: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

9 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

レスポンス例[XML の場合](ステータスライン、ヘッダ部の一部) HTTP/1.1 404 Not Found Content-Length: xx Content-Type: application/xml; charset=utf-8 ・ レスポンス例[XML の場合](ボディ部) <?xml version="1.0" encoding="utf-8" ?> <Exception> <Status>404</Status> <ErrorCode>2002</ErrorCode> <Message>The requested resource was not found</Message> </Exception> なお、http メッセージボディを用いないエラーレスポンスを行なう場合があります。(例:URI 入力のミスでサーバに到達しない場合、等) 1.3.5 エラーコード 返却するエラーコードの意味は以下の通りです。 ErrorCode 説明 0003 サーバエラーが発生。 サーバ内部で致命的なエラーが発生しました。管理者へ問い合わせが必要です。 0006 パラメータエラーです。 指定されたパラメータのいずれかが誤っています。 0007 トークン認証エラーです。 指定されたトークンが無効か認証期限が切れています。 0008 取得対象のリソースが存在しません。 9404 指定された URLは存在しません。 9405 指定されたリクエストメソッドはサポートされません。 サポートされるメソッドはHTTPレスポンスヘッダ Allowで通知されます。 9415 指定された Content-Typeはサポートされません。 "application/xml"または "application/json;charset=UTF-8"のみ指定可能です。

Page 16: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

10 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

9401 リクエストパラメータが不正です。 エラー詳細は Messageで返却します。 9402 リクエストパラメータが不正です。 エラー詳細は Message で返却します。 9403 リクエストパラメータが不正です。 POST されたメッセージの形式が誤っています。 1.3.6 日付と時刻 日付と時刻のフォーマットは、ISO 8601(JIS X 0301)に準拠します。 ・年月日のみの表記 YYYY-MM-DD ・時分秒のみの表記 hh:mm:ss ・年月日+時分秒の表記 YYYY-MM-DDThh:mm:ssTZD(例:2014-12-31T12:34:56+09:00)

Page 17: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

11 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.3.7 リスト形式 サービス事業者向け API は、リソースをリスト形式で提供する場合があります。 リスト形式での取得は“ページ”単位に分割したリストの提供とします。 入力パタメータにはページに関するプロパティを指定します。 出力パラメータにはリソースプロパティと、ページに関するプロパティが追加されます。 ・入力パラメータ プロパティ 説明 Page ページ番号です。 入力を省略することが可能です。その場合、0(先頭ページ)が設定されます。 ItemsPerPage

各ページに返すリソースの数です。 デフォルト値、最大値が定義されます。 入力を省略することが可能です。その場合、デフォルト値が設定されます。最大値を超える値の場合は最大値が設定されます。 本番環境における値は以下の通りです。 デフォルト値: 500 最大値: 1,000 この値は変更する場合があります。この値のリソースが必ず返却される前提での利用はできません。 ・出力パラメータ プロパティ 説明 (RootElement) リスト形式のルート要素です。リソース名+List の文字列です。(例: HemsUsersList)

Page 現在のページ番号です。 ゼロから数えます。最初のページが 0 になります。 TotalPages 総ページ数です。 ItemsPerPage 各ページの項目数です。 TotalItems リストリソースの総項目数です。 Start ページの先頭の項目の、リスト全体での位置です。ゼロから数えます。 End ページの末尾の項目の、リスト全体での位置です。ゼロから数えます。 FirstPageUri このリストリソースの最初のページの URI です。

Page 18: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

12 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

NextPageUri このリストリソースの次のページの URI です。 (当該ページが最後のページの場合は返却しません) PreviousPageUri このリストリソースの前のページの URI です。 (当該ページが最初のページの場合は返却しません) LastPageUri このリストリソースの最後のページの URI です。 Uri 現在のページの URI です。 ページを連続して取得する場合は、NextPageUri パラメータを使い、次のページを取得します。 ・注意事項 同一のリストリソースのページを連続して取得しているタイミングで、新しいリソースがリスト中に挿入された場合、連続したページ間で、リソースが重複する可能性があります。 リストリソースの取得時にstartCreateTimeとendCreateTimeによるフィルタを、リソースの生成日時に対して過去日時を条件とすることで新しいリソースが結果リスト中に挿入されることを回避できます。 フィルタの指定は各 API のリストリソースの説明(「1.6 提供 API 詳細」)を参照してください。 ・リスト形式の運用事例 リスト形式によるリソースの取得は、参照可能なリソースを1度にまとめて取得したい場合に利用できます。 例 1.指定期間に登録した HEMS 利用者を一覧取得する

Page 19: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

13 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合](HEMS 利用者リストリソース取得) GET /hemscommon/ver1.0/HemsUsers.json?Page=0&ItemsPerPage=100" ・レスポンス例[JSON の場合](HEMS 利用者リストリソース取得) { "HemsUsersList": { "Page": 0, "TotalPages": 11, "ItemsPerPage": 100, "TotalItems": 1001, "Start": 0, "End": 99, "Uri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&ItemsPerPage=100", "FirstPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=0&ItemsPerPage=100", "NextPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=1&ItemsPerPage=100", "LastPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=10&ItemsPerPage=100", "HemsUser": [ { "HemsUserId":"abcdefghijklmnopqrstuvwx12345678", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/abcdefghijklmnopqrstuvwx12345678\/HemsUser.json" }, { "HemsUserId":"1234567890abcdefghijklmnopqrstuv", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/HemsUser.json" }, {(略) } ] } }

Page 20: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

14 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合](HEMS 利用者リストリソース取得) GET /hemscommon/ver1.0/HemsUsers.xml?Page=0&ItemsPerPage=100" ・レスポンス例[XML の場合](HEMS 利用者リストリソース取得) <?xml version="1.0" encoding="utf-8" ?> <HemsUsersList> <Page>0</Page> <TotalPages>11</TotalPages> <ItemsPerPage>100</ItemsPerPage> <TotalItems>1001</TotalItems> <Start>0</Start> <End>99</End> <Uri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&ItemsPerPage=100</Uri> <FirstPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=0&ItemsPerPage=100</FirstPageUri> <NextPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=1&ItemsPerPage=100</NextPageUri> <LastPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=10&ItemsPerPage=100</LastPageUri> <HemsUsers> <HemsUser> <HemsUserId>abcdefghijklmnopqrstuvwx12345678</HemsUserId> <Uri>/hemscommon/ver1.0/ServiceConnections/abcdefghijklmnopqrstuvwx12345678/HemsUser.xml</Uri> </HemsUser> <HemsUser> <HemsUserId>1234567890abcdefghijklmnopqrstuv</HemsUserId> <Uri>/hemscommon/ver1.0/ServiceConnections/1234567890abcdefghijklmnopqrstuv/HemsUser.xml</Uri> </HemsUser> (略) </HemsUsers> </HemsUsersList>

Page 21: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

15 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.3.8 サマリ形式 サービス事業者向け API は、各リソースの Idを、サマリ形式で提供する場合があります。サマリ形式を利用したい場合は、入力パラメータでサマリ形式を指定します。 出力パラメータはリソースの Id と URI のみで、リスト形式で提供します。 入力パラメータは以下のサマリ形式固有パラメータの他にリスト形式のパラメータが必要となります。また、出力パラメータはリスト形式の出力パラメータが同時に返却されます。リスト形式については、1.3.7 リスト形式を参照してください。 ・入力パラメータ プロパティ 説明 Format サマリ形式を指定するためのプロパティです。 入力を省略することが可能です。サマリ形式の場合は”summary”を指定します。 ・出力パラメータ(例:HEMS 利用者リソースの場合) プロパティ 説明 (RootElement) リスト形式のルート要素です。リソース名+List の文字列です。 (例: CollectDataList) HemsUserId HEMS 利用者を識別するための 32 文字の文字列です。HEMS 利用者の契約時など、HEMS 情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS情報基盤への収集データの提供を禁止したタイミングで削除されます。 なお、HEMS サービスの提供において取り扱われる ID とは異なります。 Uri リソースの URI です。https://{ドメイン、もしくは IP アドレス}からの相対パスです。 ・リクエスト例[JSON の場合](HEMS 利用者リソース) GET /hemscommon/ver1.0/HemsUsers.json?Format=summary&ItemsPerPage=100

Page 22: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

16 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・レスポンス例[JSON の場合](HEMS 利用者リソース) { "HemsUsersList": { "Page": 0, "TotalPages": 11, "ItemsPerPage": 100, "TotalItems": 1001, "Start": 0, "End": 99, "Uri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&ItemsPerPage=100", "FirstPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=0&ItemsPerPage=100", "NextPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=1&ItemsPerPage=100", "LastPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=10&ItemsPerPage=100", "HemsUser": [ { "HemsUserId":"abcdefghijklmnopqrstuvwx12345678", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/abcdefghijklmnopqrstuvwx12345678\/HemsUser.json" }, { "HemsUserId":"1234567890abcdefghijklmnopqrstuv", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/HemsUser.json" }, { (略) } ] } }

Page 23: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

17 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合](HEMS 利用者リソース) GET /hemscommon/ver1.0/HemsUsers.xml?Format=summary&ItemsPerPage=100 ・レスポンス例[XML の場合](HEMS 利用者リソース) <?xml version="1.0" encoding="utf-8" ?> <HemsUsersList> <Page>0</Page> <TotalPages>11</TotalPages> <ItemsPerPage>100</ItemsPerPage> <TotalItems>1001</TotalItems> <Start>0</Start> <End>99</End> <Uri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&ItemsPerPage=100</Uri> <FirstPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=0&ItemsPerPage=100</FirstPageUri> <NextPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=1&ItemsPerPage=100</NextPageUri> <LastPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=10&ItemsPerPage=100</LastPageUri> <HemsUsers> <HemsUser> <HemsUserId>abcdefghijklmnopqrstuvwx12345678</HemsUserId> <Uri>/hemscommon/ver1.0/ServiceConnections/ abcdefghijklmnopqrstuvwx12345678/HemsUser.xml</Uri> </HemsUser> <HemsUser> <HemsUserId>1234567890abcdefghijklmnopqrstuv</HemsUserId> <Uri>/hemscommon/ver1.0/ServiceConnections/ 1234567890abcdefghijklmnopqrstuv/HemsUser.xml</Uri> </HemsUser> (略) <HemsUsers> <HemsUsersList>

Page 24: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

18 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.3.9 リスト形式、サマリ形式を提供する API 以下の APIがリスト形式およびサマリ形式を提供しています。 ・リスト形式を提供する API 1.6.1(2)HEMS 利用者取得(リストリソース取得) 1.6.9(2)節電アドバイス一覧取得 1.6.13(2)グローバル IP アドレス一覧取得 ・サマリ形式を提供する API 1.6.1(3)HEMS 利用者取得(リストリソース取得(サマリ取得)) 1.3.10 クエリストリングの URL エンコード GETメソッドでリクエストを行う APIのうち、入力パラメータを URLのクエリストリングで指定する API の場合、パラメータ値を URL エンコードして指定してください。URLエンコードする必要がある文字列は以下の通りです。

文字種 (エンコード前) エンコード後 文字種 (エンコード前) エンコード後 SPACE %20 : %3A ! %21 ; %3B " %22 < %3C # %23 = %3D $ %24 > %3E % %25 ? %3F & %26 @ %40 ' %27 [ %5B ( %28 ] %5D ) %29 ^ %5E * %2A ` %60 + %2B { %7B , %2C | %7C / %2F } %7D ~ %7E

Page 25: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

19 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

クエリストリング中の「:」(コロン)はURLエンコード必須ではありません。パラメータ値として正常に解釈いたします。

◆URLエンコードが必要な API ・メソッド:GET ・入力パラメータ(URI指定)の値に URLエンコードが必要

本 API 仕様書では可読性向上のため URL エンコード前の文字で表記しますが、実際の利用は URL エンコードを実施してください。 例 1)HEMS利用者取得 API /hemscommon/ver1.0/HemsUsers? startCreateTime=2014-08-01T00%3A00%3A00%2B09%3A00&endCreateTime=2014-09-01T00%3A00%3A00%2B09%3A00 「:」を 「%3A」にエンコード 「+」を「%2B」にエンコード

例)収集データ取得 API /hemscommon/ver1.1/ServiceConnections/{ServiceConnectionId}/CollectData.json?startCollectTime=2014-08-01T00%3A00%3A00%2B09%3A00&endCollectTime=2014-08-31T23%3A59%3A59%2B09:00 「:」を 「%3A」にエンコード 「+」を「%2B」にエンコード

Page 26: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

20 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.4 セキュリティ

1.4.1 通信の暗号化 API アクセスは SSL(HTTPS)のみを提供します。データのプライバシ保護のため、暗号化されない HTTP はサポートされません。 1.4.2 認証方式 API アクセス時には、認証トークンを必要とします。 認 証 ト ー ク ン は 、 認 証 ト ー ク ン 要 求 API を 利 用 し て 、 指 定 し たServiceProviderPortalId と Passwordで HEMS 情報基盤が認証を行い生成します。 認証が連続で設定回数以上失敗した場合は、指定した ServiceProviderPortalId は利用できなくなります。管理画面により利用停止解除を行うことで認証再開します。 1.5 REST リソース REST リソース一覧を以下に示します。 標準/拡張 REST リソース 日本語名称 定義 標準 HemsUsers HEMS 利用者 サービスに対して HEMS 利用者が認可を与えた HEMS 利用者の属性情報を表すリソースです。 標準 CollectData 収集データ サービスに対して HEMS 利用者が認可を与えた HEMS データを表すリソースです。 拡張 ServiceConnections サービス連携 サービス事業者が提供するサービスに対し、HEMS 利用者が認可を与えた状態を示すリソースです。サービスの申込単位に生成されます。 拡張 Authentication 認証トークン API を利用する際に必要な認証トークンです。 拡張 HemsContents コンテンツ HEMS表示端末向けに作成されたコンテンツリソースです。 拡張 HemsAnalyses 分析(状態) HEMS情報基盤により分析された状

Page 27: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

21 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

態種別による分析情報データを表すリソースです。 拡張 HemsStatic 分析(属性) HEMS情報基盤により分析された属性種別による分析情報データを表すリソースです。 拡張 HemsEvents 分析(イベント) HEMS情報基盤により分析されたイベント種別による分析情報データを表すリソースです。 拡張 GlobalIpAddress グローバルIPアドレス HEMS 利用者が利用しているグローバル IP アドレスを表すリソースです。集合住宅など複数の HEMS 利用者が同じアドレスを持つ場合もあります。

Page 28: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

22 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6 提供 API 詳細

1.6.1 HEMS 利用者(HemsUsers) (1) インスタンスリソース取得 サービス連携リソースを指定し、HEMS 利用者リソースのプロパティ一覧を返却します。 プライバシに関わる各種プロパティは、HEMS 利用者の認可(許可)が得られた範囲のみ提供されます。HEMS 利用者の認可(許可)が得られていないプロパティは応答に含まれません。 なお、プライバシに関わる各種プロパティは HEMS 利用者の登録内容によって、空の値・誤った値が含まれる場合があります。 ・メソッド GET ・URI /hemscommon/ver1.0/ServiceConnections/{ServiceConnectionId}/HemsUser.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 HemsUser HEMS 利用者リソースプロパティの集合です。 HemsUserId HEMS 利用者を識別するための 32 文字の文字列です。HEMS利用者の契約時など、HEMS 情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS 情報基盤への収集データの提供を禁止したタイミングで削除されます。 なお、HEMS サービスの提供において取り扱われる ID とは異なります。 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。

Page 29: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

23 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

DateCreated HEMS 利用者の生成された年月日時分秒です。ISO 8601 フォーマットを使用します。 DateUpdated HEMS 利用者の更新された年月日時分秒です。ISO 8601 フォーマットを使用します。 Service サービスリソースへのリンクです。 HEMS情報基盤実装では必ず空文字が設定されます。 ServiceConnection サービス連携リソースへのリンクです。 HEMS情報基盤実装では必ず空文字が設定されます。 AggregatorId HEMS 管理事業者 ID を示す 3桁の文字列です。 HemsUserLastName HEMS 利用者の”姓”を示す最大 20 文字の文字列です。 HemsUserFirstName HEMS 利用者の”名”を示す最大 20 文字の文字列です。 HemsUserLastNameKana HEMS 利用者の氏のふりがなを示す最大 40 文字の文字列です。(全角平仮名表記) HemsUserFirstNameKana HEMS 利用者の名のふりがなを示す最大 40 文字の文字列です。(全角平仮名表記) TelephoneNumber HEMS 利用者の連絡先電話番号です。最大 11桁の半角数字です。ハイフン(-)は含みません。 MailAddress HEMS 利用者の連絡先メールアドレスを示す文字列です。 MailAddress1 HEMS 利用者の転送用メールアドレスを示す文字列です。 MailAddress2 HEMS 利用者の転送用メールアドレスを示す文字列です。 MailAddress3 HEMS 利用者の転送用メールアドレスを示す文字列です。 MailAddress4 HEMS 利用者の転送用メールアドレスを示す文字列です。 MailAddress5 HEMS 利用者の転送用メールアドレスを示す文字列です。 BirthYear HEMS 利用者の生年です。 Sex HEMS 利用者の性別です。(男性/女性) WorkType HEMS 利用者の就労就学区別です。 (公務員/会社員/自営業/主婦/学生(高校生以上)/中学生以下/パート・アルバイト/無職) WorkType2 HEMS 利用者の就労就学区別2です。 (公務員/会社員/自営業/専業主婦・主夫/大学生/専門学生 /パート・アルバイト/その他) WorkTypeOther HEMS 利用者の就労就学区別2がその他の場合に入力された就労就学区分名です。全角15桁。 FamilyStructure HEMS 利用者の家族構成(人数)です。本人を含みます。1~19 FamilyDataList HEMS 利用者の家族毎の情報の配列です。(XML の場合に返却) FamilyData HEMS 利用者の家族毎の情報です。

Page 30: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

24 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

BirthYear HEMS 利用者の家族の生年です。 Sex HEMS 利用者の家族の性別です。 WorkType HEMS 利用者の家族の就労就学区別です。 WorkType2 HEMS 利用者の家族の就労就学区別2です。 WorkTypeOther HEMS 利用者の家族の就労就学区別2がその他の場合に入力された就労就学区分名です。全角 15桁。 Pet ペット有無です。 ペットの種類毎の有無を表す数字(「1=あり」「0=なし」「9=不明」)が1バイト目から設定されます。 バイト位置に対応するペットの種類は以下の通りです。 [0] : 犬 [1] : 猫 [2] : 熱帯魚 [31] : その他 [3]~[30] : 未定義 ※[n]の nはバイト位置を表します。 なお、未定義の要素には 9 が設定されます。 PetOther ペット有無「31:その他」が 1:ありの場合に入力されたペット種別名です。全角 10桁。 ZipCode 郵便番号です。7 桁の半角数字です。ハイフン(-)は含みません。 Prefectural 住所(都道府県)を示す文字列です。 Municipality 住所(市町村)を示す文字列です。 Address1 住所(番地)を示す文字列です。 Address2 住所(マンション名、号室)を示す文字列です。 Latitude 住所の緯度(小数点以下第 8 位まで) Longitude 住所の経度(小数点以下第 8 位まで) CouncilName 所属自治会名です。 BuildType 建・集合の区別です。(戸建/集合) BuildOwnerShip 賃貸・持家の区分です。(賃貸/持家) BuildFloorSpace 建物の延床面積です。(小数点以下第 2 位まで) BuildYear 建物の竣工年です。 BuildArchitect 建物の構造です。(木造/鉄骨/鉄筋コンクリート) AnnualIncome 年収です。 LeisureCosts 世帯レジャー費(年間)です。 NumberOfRooms 部屋数です。

Page 31: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

25 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

InternetType インターネット回線プロバイダー名です。 InternetProvider インターネットサービスプロバイダー名です。 NumberOfPc パソコン台数です。 ElectricPowerCompany 電力会社です。 (北海道電力/東北電力/東京電力/北陸電力/中部電力/関西電力/中国電力/四国電力/九州電力/沖縄電力/その他) PowerPricePlan 電力会社との契約プランです。 (従量電灯B(10A)/従量電灯B(15A)/従量電灯B(20A)/従量電灯B(30A)/従量電灯B(40A)/従量電灯B(50A)/従量電灯 B(60A)/その他) PowerPricePlan2 電力会社との契約プラン(その他)です。 (従量電灯 A/E ライフプラン/タイムプラン/ピークシフト電灯/従量電灯 C) PowerPricePlanSub 電力会社との契約プラン(付帯メニュー)です。 (マイコン型蓄熱器割引/5 時間通電機器割引/低圧深夜電力 A/低圧深夜電力 B/第 2深夜電力) GasType ガス種別です。(都市ガス/LPガス/契約なし) AllElectricType オール電化/ガス併用の区別です。(オール電化/ガス併用) WaterHeater 給湯器情報です。 (高効率ガス給湯器(エコジョーズ)/ガス給湯器(上記以外のもの)/高効率灯油給湯器(エコフィール)/灯油給湯器(上記以外のもの)/ヒートポンプ式給湯器(エコキュート)/電気温水器(エコキュートを除く)/ガスエンジン給湯器(エコウィル)/燃料電池(エネファーム)/その他/なし) CookingDevice 調理器具の種別です。 (ガスコンロ/IHヒーター/ラジエントヒーター/なし) PvInstallation PV 発電設備の有無です。(「1=あり」「0=なし」「9=不明」) DeviceList2 の[0]太陽光発電設備と同値です。 DeviceList1 主要機器の有無 1 です。 機器毎の所持状態を表す数字(「1=あり」「0=なし」「9=不明」)が1バイト目から設定されます。 バイト位置に対応する機器は以下の通りです。 [0] : 全館空調システム(家全体の空気調整を行うための仕組み)

Page 32: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

26 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

[1] : 浴室乾燥機(洗濯物を乾燥させる機能) [2] : 洗濯機(乾燥機能つき) [3] : 洗濯機(乾燥機能なし) [4] : 電気ポット(保温式のもの) [5] : 浴槽 追い炊き機能なし [6] : 浴槽 追い炊き機能付き [7] : 太陽熱利用設備(太陽熱温水器/ソーラーシステム) [8] : エアコン(全館暖房を除く) [9] : 冷蔵庫 [10] : テレビ [11] : 電子レンジ [12] : パソコン [13] : 食器洗い乾燥機 [14] : ガスファンヒーター [15] : 電気炊飯器 [16] : DVD レコーダー [17]~[31] : 未定義 ※[n]の nはバイト位置を表します。 なお、機器未定義の要素には 9 が設定されます。 DeviceList2 主要機器の有無 2 です。 機器毎の所持状態を表す数字(「1=あり」「0=なし」「9=不明」)が1バイト目から設定されます。 バイト位置に対応する機器は以下の通りです。 [0] : 太陽光発電設備 [1] : 蓄電池設備 [2] : 電気自動車・プラグインハイブリッド自動車用充電設備 [3]~[31] : 未定義 ※[n]の nはバイト位置を表します。 なお、機器未定義の要素には 9 が設定されます。 DeviceList3 主要機器の有無 3 です。 機器毎の所持状態を表す数字(「1=あり」「0=なし」「9=不明」)が1バイト目から設定されます。 バイト位置に対応する機器は以下の通りです。 [0] : 温水洗浄器 [1] : 掃除機 [2] : ウォーターサーバ

Page 33: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

27 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

[3]~[31] : 未定義 ※[n]の nはバイト位置を表します。 なお、機器未定義の要素には 9 が設定されます。 SavingEp HEMS 利用者の意識調査項目:節電意識の区分です。 1:強く意識している 2:まあまあ意識している 3:あまり意識していない 4:全く意識していない SavingCost HEMS 利用者の意識調査項目:節約意識の区分です。 1:強く意識している 2:まあまあ意識している 3:あまり意識していない 4:全く意識していない EpProvideConcern HEMS 利用者の意識調査項目:電力情報提供懸念の区分です。 1:強く感じる 2:まあまあ感じる 3:あまり感じない 4:全く感じない Uri リソースの URI です。https://{ドメイン、もしくは IP アドレス}からの相対パスです。 ・リクエスト例[JSON の場合] GET /hemscommon/ver1.0/ServiceConnections/abcdefghijklmnopqrstuvwxyz123456/HemsUser.json ・レスポンス例[JSON の場合] { "HemsUser":{ "HemsUserId":"abcdefghijklmnopqrstuvwx12345678", "ServiceConnectionId":"abcdefghijklmnopqrstuvwxyz123456", "DateCreated":"2014-12-31T01:16:24+09:00", "DateUpdated":"2014-12-31T01:16:24+09:00", "Service":"", "ServiceConnection":"", "HemsUserName": "山田 太郎", "TelephoneNumber": "0312345678", "MailAddress": "[email protected]", "ZipCode": "1011234", "BirthYear":"1980", "Sex":"男性", "WorkType":"会社員", "FamilyStructure":"4",

Page 34: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

28 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

"FamillyData":[ {"BirthYear":"1995","Sex":"男性","WorkType":"会社員"}, {"BirthYear":"2010","Sex":"女性","WorkType":"中学生以下"} ], (略) "ElectricPowerCompany":"東京電力", "PowerPricePlan":"従量電灯 B(10A)", "GasType":"都市ガス", "AllElectricType":"ガス併用", "WaterHeater":"一般給湯器", "CookingDevice":"ガスコンロ", "DeviceList1":"11111111111111111999999999999999", "DeviceList2":"11199999999999999999999999999999", "DeviceList3":"11199999999999999999999999999999", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/abcdefghijklmnopqrstuvwx12345678\/HemsUser.json" } } ・リクエスト例[XML の場合] GET /hemscommon/ver1.0/ServiceConnections/abcdefghijklmnopqrstuvwxyz123456/HemsUser.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <HemsUser> <HemsUserId>abcdefghijklmnopqrstuvwx12345678</HemsUserId> <ServiceConnectionId>abcdefghijklmnopqrstuvwxyz123456</ServiceConnectionId> <DateCreated>2014-12-31T01:16:24+09:00</DateCreated> <DateUpdated>2014-12-31T01:16:24+09:00</DateUpdated> <Service></Service> <ServiceConnection></ServiceConnection> <HemsUserName>山田 太郎</HemsUserName> <TelephoneNumber>0312345678</TelephoneNumber> <MailAddress>[email protected]</MailAddress> <ZipCode>1011234</ZipCode>

Page 35: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

29 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<BirthYear>1980</BirthYear> <Sex>男性</Sex> <WorkType>会社員</WorkType> <FamilyStructure>4</FamilyStructure> <FamillyDataList> <FamillyData> <BirthYear>1995</BirthYear> <Sex>男性</Sex> <WorkType>会社員</WorkType> </FamillyData> <FamillyData> <BirthYear>2010</BirthYear> <Sex>女性</Sex> <WorkType>中学生以下</WorkType> </FamillyData> </FamillyDataList> (略) <ElectricPowerCompany>東京電力</ElectricPowerCompany> <PowerPricePlan>従量電灯 B(10A)</PowerPricePlan> <GasType>都市ガス</GasType> <AllElectricType>ガス併用</AllElectricType> <WaterHeater>一般給湯器</WaterHeater> <CookingDevice>ガスコンロ</CookingDevice> <DeviceList1>11111111111111111999999999999999</DeviceList1> <DeviceList2>11199999999999999999999999999999</DeviceList2> <DeviceList3>11199999999999999999999999999999</DeviceList3> <Uri>/hemscommon/ver1.0/ServiceConnections/abcdefghijklmnopqrstuvwx12345678/HemsUser.xml</Uri> </HemsUser>

Page 36: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

30 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(2) リストリソース取得 サービス連携リソースを指定せず、複数の HEMS 利用者に関するプロパティ一覧を返却します。 ・メソッド GET ・URI /hemscommon/ver1.0/HemsUsers.{json、または、xml を指定}?Page=xxx&ItemsPerPage=xxx ・入力パラメータ(URI指定) リスト形式で取得する際の入力パラメータについては、1.3.7 リスト形式を参照してください。 ・出力パラメータ HemsUsers インスタンスリソースと同様のプロパティをリスト形式で返却します。 リスト形式で取得する方法については、1.3.7 リスト形式を参照してください。 プロパティ 説明 HemsUsersList HEMS 利用者リストリソースです。 HemsUsers HEMS 利用者リソースの集合です。(XML の場合に返却) HemsUser ※インスタンスリソースと同様のプロパティ集合を返却します。 ・フィルタリング条件(1.データ生成期間指定) データ生成日時の期間指定が可能です。API 利用者は、リスト上の DateCreated プロパティに対する、startCreateTime から endCreateTime未満のフィルタを設定します。(どちらか一方を省略することが可能) {URI}?startCreateTime=2014-08-01T00:00:00+09:00&endCreateTime=2014-09-01T00:00:00+09:00 ・フィルタリング条件(2.データ更新期間指定) データ更新日時の期間指定が可能です。API 利用者は、リスト上の DateUpdated プロパティに対する、startUpdateTime から endUpdateTime未満のフィルタを設定します。(どちらか一方を省略することが可能) {URI}?startUpdateTime=2014-08-01T00:00:00+09:00&endUpdateTime=2014-09-01T00:00:00+09:00

Page 37: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

31 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(3) リストリソース取得(サマリ取得) (2)リストリソース取得をサマリ形式で返却します。 サマリ形式で取得する方法については、1.3.8 サマリ形式を参照してください。 ・メソッド GET ・URI /hemscommon/ver1.0/HemsUsers.{json、または、xml を指定}?Format=summary&Page=xxx&ItemsPerPage=xxx ・入力パラメータ(URI指定) サマリ形式で取得する際の入力パラメータについては、1.3.8 サマリ形式を参照してください。 ・出力パラメータ リストリソースを以下の出力パラメータに集約して返却します。 サマリ形式でリスト取得する方法については、1.3.8 サマリ形式を参照してください。 プロパティ 説明 HemsUsersList HEMS 利用者リストリソースです。 HemsUsers HEMS 利用者リソースの集合です。(XML の場合に返却) HemsUser HEMS 利用者リソースプロパティの集合です。 HemsUserId HEMS利用者を識別するための 32文字の文字列です。HEMS利用者の契約時など、HEMS情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS情報基盤への収集データの提供を禁止したタイミングで削除されます。 なお、HEMS サービスの提供において取り扱われる ID とは異なります。 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 Uri リソースの URI です。https://{ドメイン、もしくは IPアドレス}からの相対パスです。 ・フィルタリング条件 「(2)リストリソース取得」のフィルタリング条件を指定できます。

Page 38: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

32 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] GET /hemscommon/ver1.0/HemsUsers.json?Format=summary&ItemsPerPage=100 ・レスポンス例[JSON の場合] { "HemsUsersList": { "Page": 0, "TotalPages": 11, "ItemsPerPage": 100, "TotalItems": 1001, "Start": 0, "End": 99, "Uri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&ItemsPerPage=100", "FirstPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=0&ItemsPerPage=100", "NextPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=1&ItemsPerPage=100", "LastPageUri":"\/hemscommon\/ver1.0\/HemsUsers.json?Format=summary&Page=10&ItemsPerPage=100", "HemsUser": [ { "HemsUserId":"abcdefghijklmnopqrstuvwx12345678", "ServiceConnectionId":"abcdefghijklmnopqrstuvwx12345678", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/abcdefghijklmnopqrstuvwx12345678\/HemsUser.json" }, { "HemsUserId":"1234567890abcdefghijklmnopqrstuv", "ServiceConnectionId":"1234567890abcdefghijklmnopqrstuv", "Uri":"\/hemscommon\/ver1.0\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/HemsUser.json" }, {(略) } ] } }

Page 39: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

33 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] GET /hemscommon/ver1.0/HemsUsers.xml?Format=summary&ItemsPerPage=100 ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <HemsUsersList> <Page>0</Page> <TotalPages>11</TotalPages> <ItemsPerPage>100</ItemsPerPage> <TotalItems>1001</TotalItems> <Start>0</Start> <End>99</End> <Uri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&ItemsPerPage=100</Uri> <FirstPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=0&ItemsPerPage=100</FirstPageUri> <NextPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=1&ItemsPerPage=100</NextPageUri> <LastPageUri>/hemscommon/ver1.0/HemsUsers.xml?Format=summary&Page=10&ItemsPerPage=100</LastPageUri> <HemsUsers> <HemsUser> <HemsUserId>abcdefghijklmnopqrstuvwx12345678</HemsUserId> <ServiceConnectionId>abcdefghijklmnopqrstuvwx12345678</ServiceConnectionId> <Uri>/hemscommon/ver1.0/ServiceConnections/abcdefghijklmnopqrstuvwx12345678/HemsUser.xml</Uri> </HemsUser> <HemsUser> <HemsUserId>1234567890abcdefghijklmnopqrstuv</HemsUserId> <ServiceConnectionId>1234567890abcdefghijklmnopqrstuv</ServiceConnectionId> <Uri>/hemscommon/ver1.0/ServiceConnections/1234567890abcdefghijklmnopqrstuv/HemsUser.xml</Uri> </HemsUser> (略) </HemsUsers> </HemsUsersList>

Page 40: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

34 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.2 収集データ(CollectData) (1) リストリソース取得(HEMS 利用者単位)Ver1.1 ServiceConnectionId が共通する収集データリソースのプロパティをリスト形式で返却します。 リストリソース形式の指定は、1.3.7 リスト形式とは異なります。ご注意ください。 複数ページに渡り返却するデータが存在する場合は、出力プロパティにNextPageUri を返却します。継続してデータを取得する場合に返却される Uri を実行してください。前ページへの Uri は返却しません。 ・メソッド GET ・URI /hemscommon/ver1.1/ServiceConnections/{ServiceConnectionId}/CollectData. {json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ItemsPerPage 各ページに返すリソースの数です。 デフォルト値、最大値が定義されます。 入力を省略することが可能です。その場合、デフォルト値が設定されます。最大値を超える値の場合は最大値が設定されます。 startCollectTime endCollectTime 以下、フィルタリング条件(1.データ収集期間指定)参照 startCreateTime endCreateTime 以下、フィルタリング条件(2.データ蓄積期間指定)参照 ・フィルタリング条件(1.データ収集期間指定) 収集データ取得 API では、データ収集期間もしくはデータ蓄積期間のいずれかをを指定する必要があります。データ収集期間は、リスト上の Timestamp プロパティに対する条件であり、startCollectTime および endCollectTime を指定します。

Page 41: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

35 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

API は、指定された startCollectTime から endCollectTime未満のデータを返却します。 {URI}?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00 ・フィルタリング条件(2.データ蓄積期間指定) 収集データ取得 API では、データ収集期間もしくはデータ蓄積期間のいずれかをを指定する必要があります。データ蓄積期間は、リスト上の DataCreated プロパティに対する条件であり、startCreateTime および endCreateTime を指定します。API は、指定された startCreateTime から endCreateTime未満のデータを返却します。 {URI}?startCreateTime=2014-08-01T00:00:00+09:00&endCreateTime=2014-08-31T23:59:59+09:00 ・出力パラメータ 収集データインスタンスリソースと同様のプロパティをリスト形式で返却します。 プロパティ 説明 CollectDataList 収集データリストリソースです。 ItemsPerPage 各ページの項目数です。 FirstPageUri このリストリソースの最初のページの URI です。 NextPageUri このリストリソースの次のページの URI です。 (当該ページが最後のページの場合は返却しません) Uri 現在のページの URI です。 CollectData 収集データリソースの集合です。(XML の場合に返却) CollectDatum 収集データリソースプロパティの集合です。 CollectDataId HEMS 情報基盤に収集データを蓄積する際に付与される、収集データを識別するための 32桁の文字列です。 HEMS情報基盤実装では必ず空文字が設定されます。 DateCreated HEMS 情報基盤に収集データが登録された年月日時分秒です。ISO 8601 フォーマットを使用します。 Timestamp ECHONET Lite を用いて、HEMS等がプロパティを収集した際の年月日時分秒です。ISO 8601 フォーマットを使用します。 ServiceConnection サービス連携リソースへのリンクです。 HEMS情報基盤実装では必ず空文字が設定されます。 HemsUser HEMS 利用者リソースへのリンクです。 NodeId HEMS が機器を一意に識別するための ID です。HEMS によって

Page 42: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

36 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

異なりますが、MAC アドレス等の文字列が入力されます。 Eoj ECHONET Lite 通信ミドルウェア仕様で定義される ECHONETオブジェクトです。16 進数を示す”0x”+クラスグループコード(2桁)、クラスコード(2桁)、インスタンス番号(2桁)の合計 8 文字の文字列です。 Esv ECHONET Lite サービスを示すコードです。プロパティ値をどのように取得したかを示します。16進数を示す"0x"+ESVコード(2桁)の合計 4 文字の文字列です。 CollectProperties 収集プロパティの集合です。(XML の場合に返却) CollectProperty 収集プロパティです。Epc と Edt のペアを提供します。 XML による記述例を以下に示します。 <CollectProperties> <CollectProperty> <Epc>0x80</Epc><Edt>0x30</Edt> </CollectProperty> <CollectProperty> <Epc>0x81</Epc><Edt>0x11</Edt> </CollectProperty> </CollectProperties> JSON による記述例を以下に示します。 "CollectProperty":[ {"Epc": "0x80", "Edt": "0x30"}, {"Epc": "0x81", "Edt": "0x11"} ] Epc ECHONET プロパティコードです。16進数を示す"0x"+EPC(2桁)で表現されます。取り得る値については、参考 2.HEMS重点 8 機種から収集可能なプロパティコードを参照してください。 Edt 収集したプロパティ値です。 Uri リソースの URI です。https://{ドメイン、もしくは IP アドレス}からの相対パスです。 HEMS情報基盤実装では必ず空文字が設定されます。

Page 43: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

37 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] GET /hemscommon/ver1.1/ServiceConnections/abcdefghijklmnopqrstuvwxyz123456/CollectData.json?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100 ・レスポンス例[JSON の場合] { "CollectDataList": { "ItemsPerPage": 100, "Uri":"\/hemscommon\/ver1.1\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/CollectData.json?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100", "FirstPageUri":"\/hemscommon\/ver1.1\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/CollectData.json?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100", "NextPageUri":"\/hemscommon\/ver1.1\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/CollectData.json?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100&next=abcdef0123456789aabbccddeeff00", "CollectDatum": [ { "CollectDataId":"", "DateCreated":"2014-12-31T12:49:56+09:00", "Timestamp":"2014-12-31T12:49:56+09:00", "ServiceConnection":"", "HemsUser":"\/hemscommon\/ver1.0\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/HemsUser.json", "NodeId":"00-00-00-00-00-01", "Eoj":"0x028701", "Esv":"0x72", "CollectProperty": [ {"Epc":"0x80","Edt":"0x30"}, {"Epc":"0x82","Edt":"0x00004500"}, {"Epc":"0x8A","Edt":"0xFFFFFF"}, {"Epc":"0x97","Edt":"0x0101"}, {"Epc":"0x98","Edt":"0x07DE0101"}, {"Epc":"0x9D","Edt":"0x00"},

Page 44: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

38 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

{"Epc":"0x9E","Edt":"0x00"}, {"Epc":"0x9F","Edt":"0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"}, {"Epc":"0xD7","Edt":"0x01"}, {"Epc":"0xE0","Edt":"0x837875F3"}, {"Epc":"0xE1","Edt":"0x00"}, {"Epc":"0xE3","Edt":"0x7464932F"}, {"Epc":"0xE5","Edt":"0x01"}, {"Epc":"0xE7","Edt":"0x77777777"}, {"Epc":"0xE8","Edt":"0x66666666"}, {"Epc":"0xEA","Edt":"0x07DE010100000077777777"}, {"Epc":"0xEB","Edt":"0x07DE010100000077777777"} ], "Uri":"" }, { "CollectDataId":"", "DateCreated":"2014-12-31T12:49:56+09:00", "Timestamp":"2014-12-31T12:49:56+09:00", "ServiceConnection":"", "HemsUser":"\/hemscommon\/ver1.0\/ServiceConnections\/1234567890abcdefghijklmnopqrstuv\/HemsUser.json", "NodeId":"00-00-00-00-00-01", "Eoj":"0x028701", "Esv":"0x72", "CollectProperty": [ {"Epc":"0x80","Edt":"0x30"}, {"Epc":"0x82","Edt":"0x00004500"}, {"Epc":"0x8A","Edt":"0xFFFFFF"}, {"Epc":"0x97","Edt":"0x0101"}, {"Epc":"0x98","Edt":"0x07DE0101"}, {"Epc":"0x9D","Edt":"0x00"}, {"Epc":"0x9E","Edt":"0x00"}, {"Epc":"0xD7","Edt":"0x01"}, {"Epc":"0xE0","Edt":"0x837875F3"}, {"Epc":"0xE1","Edt":"0x00"}, ], "Uri":""

Page 45: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

39 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

}, { (略) } ] } } ・リクエスト例[XML の場合] GET /hemscommon/ver1.1/ServiceConnections/abcdefghijklmnopqrstuvwxyz123456/CollectData.xml?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100 ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <CollectDataList> <ItemsPerPage>100</ItemsPerPage> <Uri>/hemscommon/ver1.1/ServiceConnections/1234567890abcdefghijklmnopqrstuv/CollectData.xml?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100</Uri> <FirstPageUri>/hemscommon/ver1.1/ServiceConnections/1234567890abcdefghijklmnopqrstuv/CollectData.xml?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100</FirstPageUri> <NextPageUri>/hemscommon/ver1.1/ServiceConnections/1234567890abcdefghijklmnopqrstuv/CollectData.xml?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00&ItemsPerPage=100&next=abcdef0123456789aabbccddeeff00</NextPageUri> <CollectData> <CollectDatum> <CollectDataId></CollectDataId> <DateCreated>2014-12-31T12:49:56+09:00</DateCreated> <Timestamp>2014-12-31T12:49:56+09:00</Timestamp> <HemsUser>/hemscommon/ver1.0/ServiceConnections/1234567890abcdefghijklmnopqrstuv/HemsUser.xml</HemsUser> <NodeId>0x00000000000001</NodeId>

Page 46: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

40 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<Eoj>0x028701</Eoj> <Esv>0x72</Esv> <CollectProperties> <CollectProperty> <Epc>0x80</Epc> <Edt>0x30</Edt> </CollectProperty> <CollectProperty> <Epc>0x82</Epc> <Edt>0x00004500</Edt> </CollectProperty> <CollectProperty> <Epc>0x8A </Epc> <Edt>0xFFFFFF </Edt> </CollectProperty> <CollectProperty> <Epc>0x97</Epc> <Edt>0x0101</Edt> </CollectProperty> (略) </CollectProperties> <Uri></Uri> </CollectDatum> <CollectDatum> <CollectDataId></CollectDataId> <DateCreated>2014-12-31T12:49:56+09:00</DateCreated> <Timestamp>2014-12-31T12:49:56+09:00</Timestamp> <HemsUser>/hemscommon/ver1.0/ServiceConnections/1234567890abcdefghijklmnopqrstuv/HemsUser.xml</HemsUser> <NodeId>0x00000000000001</NodeId> <Eoj>0x028701</Eoj> <Esv>0x72</Esv> <CollectProperties> <CollectProperty> <Epc>0x80</Epc> <Edt>0x30</Edt> </CollectProperty>

Page 47: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

41 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<CollectProperty> <Epc>0x82</Epc> <Edt>0x00004500</Edt> </CollectProperty> <CollectProperty> <Epc>0x8A </Epc> <Edt>0xFFFFFF </Edt> </CollectProperty> <CollectProperty> <Epc>0x97</Epc> <Edt>0x0101</Edt> </CollectProperty> (略) </CollectProperties> <Uri></Uri> </CollectDatum> (略) </CollectData> </CollectDataList>

Page 48: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

42 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(2) リストリソース取得(全体)Ver1.1 サービス連携リソースの指定を省略し、参照可能なすべての HEMS 利用者の収集データリソースのプロパティをリスト形式で返却します。 リストリソース形式の指定は、1.3.7 リスト形式とは異なります。ご注意ください。 複数ページに渡り返却するデータが存在する場合は、出力プロパティにNextPageUri を返却します。継続してデータを取得する場合に返却される Uri を実行してください。前ページへの Uri は返却しません。 ・メソッド GET ・URI /hemscommon/ver1.1/CollectData.{json、または、xml を指定}?ItemsPerPage=xxx ・入力パラメータ(URI指定) プロパティ 説明 ItemsPerPage 各ページに返すリソースの数です。 デフォルト値、最大値が定義されます。 入力を省略することが可能です。その場合、デフォルト値が設定されます。最大値を超える値の場合は最大値が設定されます。 startCollectTime endCollectTime 以下、フィルタリング条件(1.データ収集期間指定)参照 startCreateTime endCreateTime 以下、フィルタリング条件(2.データ蓄積期間指定)参照 ・フィルタリング条件(1.データ収集期間指定) 収集データ取得 API では、データ収集期間もしくはデータ蓄積期間のいずれかをを指定する必要があります。データ収集期間は、リスト上の Timestamp プロパティに対する条件であり、startCollectTime および endCollectTime を指定します。API は、指定された startCollectTime から endCollectTime未満のデータを返却します。 {URI}?startCollectTime=2014-08-01T00:00:00+09:00&endCollectTime=2014-08-31T23:59:59+09:00 ・フィルタリング条件(2.データ蓄積期間指定)

Page 49: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

43 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

収集データ取得 API では、データ収集期間もしくはデータ蓄積期間のいずれかをを指定する必要があります。データ蓄積期間は、リスト上の DataCreated プロパティに対する条件であり、startCreateTime および endCreateTime を指定します。API は、指定された startCreateTime から endCreateTime未満のデータを返却します。 {URI}?startCreateTime=2014-08-01T00:00:00+09:00&endCreateTime=2014-08-31T23:59:59+09:00 ・出力パラメータ (1)リストリソース取得(HEMS 利用者単位)と同様のプロパティを返却します。

Page 50: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

44 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(3) 収集データに関する留意事項 収集データリソースから取得できる機器の種類と収集された蓄積電力量について、以下に留意事項を説明します。EOJ,EPCの値については「参考 2.HRMS重点 8機種からの収集プロパティ」を参照してください。

� 機器クラスの判定 収集されたデータがどの機器クラスのデータかを判定する際は、返却されるEOJ の先頭 6 桁で判定してください。7 桁目以降にも値が入っていますが、判定には使用しないでください。 (機器クラスの判定例) 返却データ

EOJ:"0x028701" この場合の機器クラス名 "0x0287" : 分電盤メータリングクラス(CTメータ)

� 積算電力量の計測値 収集される積算電力量は 16進数で返却されます。各種演算を行う場合や、需要家へ情報提供する場合は、10 進数への変換が必要です。なお、本文中の収集データ例は 10進数で記載します。

� 積算電力量の単位 収集される積算電力量の単位は、機器クラスにより異なります。低圧スマート電力量メータ(0x0288) 、分電盤メータリングクラス(0x0287)は、収集データに含まれる単位を使用してください。住宅用太陽光発電(0x0279)は、単位が 0.001kWhと定義されています。 <スマート電力量メータおよび分電盤メータリングクラスの積算電力量単位> 0x00:1kWh 0x01:0.1kWh 0x02:0.01kWh 0x03:0.001kWh 0x04:0.0001kWh 0x0A:10kWh 0x0B:100kWh 0x0C:1000kWh 0x0D:10000kWh 詳細は EchonetLiteプロパティの仕様を御参照ください。

Page 51: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

45 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

� 積算電力量のリセット 収集される積算電力量は、メータの上限値(有効桁数)を超えた場合、0にリセットされます。積算可能な上限値(有効桁数)は HEMS 管理事業者によって異なります。

(収集データの例:上限値が 99,999,999(有効桁数=8)の場合)

2014/12/10 10:00:00 99,999,998

2014/12/10 10:03:00 10 ※積算値が最大桁で折り返している

積算電力量から使用電力量を求める場合、タイムスタンプの異なる2つの積算電力量計測値の差を計算しますが、メータ上限値を超えた場合は以下の方法で使用量を求めます。

上記例のように、タイムスタンプの異なる2つの積算電力量計測値の差分値がマイナスとなる場合、上限値で折り返していると判断できます。この場合の使用電力量は(上限値-前データ+後データ+1)で求めることができます。

(使用電力量の計算例)

99,999,999 - 99,999,998 + 10 + 1 = 12 ※上限値+1で 0になるため、+1が必要。

� 積算電力量の上限値 スマートメータ(EOJ:0x0288)の場合、EchonetLiteスマート電力量メータークラス規定により、上限値(有効桁数)は「積算電力量有効桁数(0xD7)」で表されます。

CT センサ(EOJ:0x0287 ※分電盤メータリングクラスに準拠)の場合、EchonetLite 分電盤メータリングクラス規定により、上限値(有効桁数)は

99,999,999(8桁)となります。

� 機器交換時における収集データへの影響 機器交換時は、「ノード識別子」+「EOJ」の組み合わせが変更されます。この場合、正確な差分計算(電力使用量計算)は行えません。なお、交換前機器の「ノード識別子」+「EOJ」からはデータ収集が停止されます。

Page 52: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

46 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.3 サービス連携(ServiceConnections) (1) サービス利用者状態変更 サービス連携IDを指定して、HEMS情報基盤のサービス申込状態を更新します。同じサービス連携 ID/Status の変更要求を複数回受信した場合、これを許容し最後に受信した変更要求の状態が反映されます。 ・メソッド PUT ・URI /hemsoption/ver1.0/ServiceConnections/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・要求プロパティ(リクエストボディ) プロパティ 説明 ServiceConnections 状態変更通知サービス連携(XML 形式の場合に指定) Status サービスの申込状態を以下のいずれかで指定します。 ・"Contracted":情報基盤にサービスの契約が完了したことを通知します。(サービス申込完了) ・"Uncontracted":情報基盤にサービスの解約が完了したことを通知します。(サービス未契約) ・出力パラメータ プロパティ 説明 StatusUpdateResult 結果 Result サービス申込状態の更新結果が設定されます。 ・"OK":更新が成功したことを示します

Page 53: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

47 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] PUT /hemsoption/ver1.0/ServiceConnections/xxxxxxxxxxxxxx.json ・リクエスト例[JSON の場合] (ボディ部) { "Status":"Contracted" } ・レスポンス例[JSON の場合] (正常) HTTP/1.1 200 OK { "StatusUpdateResult":{ "Result":"OK" } } ・リクエスト例[XML の場合] PUT /hemsoption/ver1.0/ServiceConnections/xxxxxxxxxxxxxx.xml ・リクエスト例[XML の場合] (ボディ部) <?xml version="1.0" encoding="utf-8" ?> <ServiceConnections> <Status>Contracted</Status> </ServiceConnections> ・レスポンス例[XML の場合] (正常) HTTP/1.1 200 OK <?xml version="1.0" encoding="utf-8" ?> <StatusUpdateResult> <Result>OK</Result> </StatusUpdateResult>

Page 54: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

48 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(2) サービス連携 ID 取得(BCAS-ID) BCAS-ID に対応するサービス連携 ID を取得します。 BCAS-IDは各需要家世帯でデジタル放送受信に必要な B-CASカード番号であり、HEMS-GW 機器設置時に各需要家世帯と紐付け登録される情報です。 ・メソッド GET ・URI /hemsoption/ver1.0/ServiceConnections/Bcas/{BcasId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 BcasId 需要家世帯に存在する B-CASカード番号を識別するための20桁の文字列です。 ・出力パラメータ プロパティ 説明 ServiceConnection B-CAS 番号に紐付くサービス連携リソースです。 ServiceConnectionId B-CAS 番号に紐付くサービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/ServiceConnections/Bcas/xxxxxxxxxxxxxx.json ・レスポンス例[JSON の場合] { ServiceConnection : { "ServiceConnectionId":"1234567890abcdefghijklmnopqrstuv" } }

Page 55: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

49 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] GET /hemsoption/ver1.0/ServiceConnections/Bcas/xxxxxxxxxxxxxx.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <ServiceConnection> <ServiceConnectionId>1234567890abcdefghijklmnopqrstuv</ServiceConnectionId> </ServiceConnection>

Page 56: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

50 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(3) サービス連携 ID 取得(需要家ポータル ID) 需要家ポータル IDに対応するサービス連携 ID を取得します。 URI に指定するポータル ID は HEMS管理事業者のサフィックス(例:@kddi)付きで指定しますが、"@"は必ず URL エンコードを実施してください。 (「1.3.10 クエリストリングの URL エンコード」参照) リクエスト時に指定した需要家ポータル ID の状態(ロックアウト、無効状態)に関わらず対応するサービス連携 ID を取得します。 ・メソッド GET ・URI /hemsoption/ver1.0/ServiceConnections/Customer/{PortalId}.{json、または、xmlを指定} ・入力パラメータ(URI指定) プロパティ 説明 PortalId 需要家ポータルのログイン ID です。HEMS 管理事業者を現すサフィックス前までの 32桁に HEMS 管理事業者のサフィックスを付加した文字列です。 HEMS 管理事業者を現すサフィックスで利用する"@"は URLエンコードし%40 としてください。 (「1.3.10 クエリストリングの URL エンコード」参照) ・出力パラメータ プロパティ 説明 ServiceConnection 需要家ポータル ID に紐付くサービス連携リソースです。 ServiceConnectionId 需要家ポータル ID に紐付くサービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。

Page 57: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

51 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/ServiceConnections/Customer/1234abcd%40kddi.json ・レスポンス例[JSON の場合] (正常) { "ServiceConnection": { "ServiceConnectionId":"1234567890abcdefghijklmnopqrstuv" } } ・リクエスト例[XML の場合] GET /hemsoption/ver1.0/ServiceConnections/Customer/1234abcd%40kddi.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <ServiceConnection> <ServiceConnectionId>1234567890abcdefghijklmnopqrstuv</ServiceConnectionId> </ServiceConnection>

Page 58: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

52 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.4 認証トークン(Authentication) (1) 認証トークン要求 HTTPヘッダ「X-Authentication-token」に指定する認証トークンを返却します。 事前にサービス事業者に通知された ID、PASSWORDを入力パラメータに指定します。 同一の ID、PASSWORDであっても、認証トークン要求呼び出しの都度別々のトークン文字列を返却します。有効期限内のトークンが存在している場合も同様です。 ・メソッド POST ・URI /hemsoption/ver1.0/Authentication/AuthToken.{json、または、xml を指定} ・要求プロパティ(リクエストボディ) プロパティ 説明 Authentication 認証トークンプロパティの集合です。(XML 形式の場合に指定) ServiceProviderPortalId サービス事業者を識別するための文字列です。Password と合わせて事前にサービス事業者へ通知されます。 Password サービス事業者に通知された認証パスワードです。 ・出力パラメータ プロパティ 説明 Authentication 認証トークンプロパティの集合です。 AuthToken 認証されたトークンを表す 32桁の文字列です。 HEMS 情報基盤で提供する API を呼び出す際に HTTP ヘッダ「X-Authentication-token」に指定することで API を実行することができます。 ExpirationDate トークンの有効期限を年月日時分秒で返却します。ISO 8601 フォーマットを使用します。 返却する有効期限は、HEMS 情報基盤で提供する API を有効な認証トークンを指定して呼び出す度に延長されます。 有効期限は最後の API呼び出しから 30分です。

Page 59: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

53 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/Authentication/AuthToken.json ・リクエスト例[JSON の場合] (ボディ部) { "ServiceProviderPortalId":"portalid0123", "Password":"pass0123" } ・レスポンス例[JSON の場合] (正常) HTTP/1.1 200 OK { "Authentication": { "AuthToken":"xxxxxxxxxxxxxxxxxx", "ExpirationDate":"2014-12-31T24:59:59+09:00" } } ・レスポンス例[JSON の場合](アカウントロック時) HTTP/1.1 401 Unauthorized { "Exception": { "Status":"401" , "ErrorCode":"0001" , "Message":"Account is locked out" } }

Page 60: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

54 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] POST /hemsoption/ver1.0/Authentication/AuthToken.xml ・リクエスト例[JSON の場合] (ボディ部) <?xml version="1.0" encoding="utf-8" ?> <Authentication> <ServiceProviderPortalId>portalid0123</ServiceProviderPortalId> <Password>pass0123</Password> </Authentication> ・レスポンス例[XML の場合](正常) HTTP/1.1 200 OK <?xml version="1.0" encoding="utf-8" ?> <Authentication> <AuthToken>xxxxxxxxxxxxxxxxxx</AuthToken> <ExpirationDate>2014-12-31T24:59:59+09:00</ExpirationDate> </Authentication> ・レスポンス例[XML の場合](アカウントロック時) HTTP/1.1 401 Unauthorized <?xml version="1.0" encoding="utf-8" ?> <Exception> <Status>401</Status> <ErrorCode>0001</ErrorCode> <Message>Account is locked out</Message> </Exception>

Page 61: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

55 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.5 状態種別分析情報(HemsAnalyses) (1) 状態種別取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)における現在該当する動的状態種別プロパティを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/HemsAnalyses/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 HemsAnalyseList 状態種別分析情報リソースリストの集合です。 HemsUserId HEMS 利用者を識別するための 32 文字の文字列です。HEMS 利用者の契約時など、HEMS 情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS情報基盤への収集データの提供を禁止したタイミングで削除されます。なお、HEMS サービスの提供において取り扱われる ID とは異なります。 HemsAnalyseProperties 状態種別分析情報リソースの集合です。(XML の場合返却) HemsAnalyses 状態種別分析情報リソースプロパティの集合です StatusType 状態種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 StatusDate 状態種別が判定された年月日時分秒です。ISO 8601 フォーマットを使用します。分析情報生成のバッチ処理が起動された時間です。 Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。

Page 62: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

56 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/HemsAnalyses/abcdefghijklmnopqrstuvwxyz123456.json ・レスポンス例[JSON の場合] { "HemsAnalyseList": { "HemsUserId":"abcdefghijklmnopqrstuvwxyz123456", "HemsAnalyses": [ { "StatusType":"2", "StatusDate":"2014-12-31T24:59:59+09:00", "Probability":"0.812", "DateUpdated":"2014-12-31T24:59:59+09:00", }, { "StatusType":"3", "StatusDate":"2014-12-31T24:59:59+09:00", "Probability":"0.812", "DateUpdated":"2014-12-31T24:59:59+09:00", } ] } } ・リクエスト例[XML の場合] POST /hemsoption/ver1.0/HemsAnalyses/abcdefghijklmnopqrstuvwxyz123456.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <HemsAnalyseList> <HemsUserId>abcdefghijklmnopqrstuvwxyz123456</HemsUserId> <HemsAnalyseProperties> <HemsAnalyses> <StatusType>2</StatusType>

Page 63: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

57 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<StatusDate>2014-12-31T24:59:59+09:00</StatusDate> <Probability>0.812</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HemsAnalyses> <HemsAnalyses> <StatusType>3</StatusType> <StatusDate>2014-12-31T24:59:59+09:00</StatusDate> <Probability>0.812</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HemsAnalyses> </HemsAnalyseProperties> </HemsAnalyseList> (2) 状態種別統計取得(実装保留)※TBD 状態種別を契約者全体で統計した情報を返却します。

Page 64: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

58 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.6 属性種別分析情報(HemsStatic) (1) 世帯属性種別取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)における現在該当する属性種別プロパティを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/HemsStatic/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 HemsStaticList 属性種別分析情報リソースリストプロパティの集合です。 HemsUserId HEMS 利用者を識別するための 32 文字の文字列です。HEMS 利用者の契約時など、HEMS情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS 情報基盤への収集データの提供を禁止したタイミングで削除されます。 なお、HEMS サービスの提供において取り扱われる ID とは異なります。 HouseHoldProperties 世帯属性の集合です。(XML の場合に返却) HouseHold 世帯属性を表します。分析結果により複数の属性が返却される場合があります。 Type 属性種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。

Page 65: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

59 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

LifeStageProperties ライフステージ属性の集合です。(XML の場合に返却) LifeStage ライフステージに関する属性を表します。分析結果により複数の属性が返却される場合があります。 Type 属性種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。 LifeStyleTypeProperties ライフスタイル(型)属性の集合です。(XML の場合に返却) LifeStyleType ライフスタイル(型)に関する属性を表します。分析結果により複数の属性が返却される場合があります。 Type 属性種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。 LifeStyleTimeZoneProperties ライフスタイル(時間帯)属性の集合です。(XML の場合に返却) LifeStyleTimeZone ライフスタイル(時間帯)に関する属性を表します。分析結果により複数の属性が返却される場合があります。 Type 属性種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 TimeType ライフスタイル(時間帯)種別を特定する時間種別コードです。 このコードにより、時間情報に格納される形式が異なります。 1:開始終了時間(hh:mm-hh:mm) 2:発生時間(aa:aa@bb:bb@cc:cc@dd:dd) 3:時間量(hh:mm) ※ hh時間 mm分 TimeData TimeType毎に時間情報が格納されます。 TimeType=1・・"06:00-08:00" (開始 6:00、終了 8:00)

Page 66: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

60 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

TimeType=2・・"06:00@07:00@12:00" (6:00,7:00,12:00) TimeType=3・・"02:40" (2時間 40分) Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。 ・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/HemsStatic/abcdefghijklmnopqrstuvwxyz123456.json ・レスポンス例[JSON の場合] { "HemsStatic": { "HemsUserId":"abcdefghijklmnopqrstuvwxyz123456", "HouseHold": [ { "Type":"2", "Probability":"0.812", "DateUpdated":"2014-12-31T24:59:59+09:00" }, { "Type":"4", "Probability":"0.500", "DateUpdated":"2014-12-31T24:59:59+09:00" } ], "LifeStage": { "Type":"4", "Probability":"0.901", "DateUpdated":"2014-12-31T24:59:59+09:00" }, "LifeStyleType": [ {

Page 67: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

61 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

"Type":"6", "Probability":"0.781", "DateUpdated":"2014-12-31T24:59:59+09:00" }, { "Type":"3", "Probability":"0.681", "DateUpdated":"2014-12-31T24:59:59+09:00" } ], "LifeStyleTimeZone": { "Type":"4", "TimeType":"1", "TimeData":"06:00-09:00", "Probability":"0.901", "DateUpdated":"2014-12-31T24:59:59+09:00" } } ・リクエスト例[XML の場合] POST /hemsoption/ver1.0/HemsStatic/abcdefghijklmnopqrstuvwxyz123456.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <HemsStatic> <HemsUserId>abcdefghijklmnopqrstuvwxyz123456</HemsUserId> <HouseHoldProperties> <HouseHold> <Type>2</Type> <Probability>0.812</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HouseHold> <HouseHold> <Type>4</Type> <Probability>0.500</Probability>

Page 68: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

62 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HouseHold> </HouseHoldProperties> <LifeStageProperties> <LifeStage> <Type>4</Type> <Probability>0.901</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </LifeStage> </LifeStageProperties> <LifeStyleTypeProperties> <LifeStyleType> <Type>6</Type> <Probability>0.781</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </LifeStyleType> <LifeStyleType> <Type>3</Type> <Probability>0.681</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </LifeStyleType> </LifeStyleTypeProperties> <LifeStyleTimeZoneProperties> <LifeStyleTimeZone> <Type>4</Type> <TimeType>1</TimeType> <TimeData>06:00-09:00</TimeData> <Probability>0.901</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </LifeStyleTimeZone> </LifeStyleTimeZoneProperties> </HemsStatic> (2) 属性種別統計取得(実装保留)※TBD 属性種別を契約者全体で統計した情報を返却します。

Page 69: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

63 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.7 イベント種別分析情報(HemsEvents) (1) イベント種別取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)における現在該当するイベント種別プロパティを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/HemsEvent/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 HemsEventList イベント種別分析情報リソースリストの集合です。 HemsUserId HEMS 利用者を識別するための 32 文字の文字列です。HEMS 利用者の契約時など、HEMS情報基盤への収集データの提供を許諾したタイミングで生成されます。HEMS 利用者の契約解除など、HEMS情報基盤への収集データの提供を禁止したタイミングで削除されます。なお、HEMS サービスの提供において取り扱われる ID とは異なります。 HemsEventProperties イベント種別分析情報リソースの集合です。(XML の場合返却) HemsEvents イベント種別分析情報リソースプロパティの集合です。 EventType イベント種別を特定するコードを表す値です。 詳細は別紙を参照してください。※※※※TBTBTBTBDDDD コード値策定中コード値策定中コード値策定中コード値策定中 EventDate イベント種別が判定された年月日時分秒です。ISO 8601 フォーマットを使用します。分析情報生成のバッチ処理が起動された時間です。 Probability 状態が判定された際に求められた信頼度の確率です。小数点以下第 3 位までセットされます。 例:0.789 (78.9%) DateUpdated 分析情報が更新された年月日時分秒です。ISO 8601 フォーマットを使用します。

Page 70: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

64 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/HemsEvent/abcdefghijklmnopqrstuvwxyz123456.json ・レスポンス例[JSON の場合] { "HemsEventList": { "HemsUserId":"abcdefghijklmnopqrstuvwxyz123456", "HemsEvents": [ { "EventType":"1", "EventDate":"2014-12-31T24:59:59+09:00", "Probability":"0.812", "DateUpdated":"2014-12-31T24:59:59+09:00", }, { "EventType":"2", "EventDate":"2014-12-31T24:59:59+09:00", "Probability":"0.812", "DateUpdated":"2014-12-31T24:59:59+09:00", } ] } } ・リクエスト例[XML の場合] POST /hemsoption/ver1.0/HemsEvent/abcdefghijklmnopqrstuvwxyz123456.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <HemsEventList> <HemsUserId>abcdefghijklmnopqrstuvwxyz123456</HemsUserId> <HemsEventProperties> <HemsEvents> <EventType>1</EventType> <EventDate>2014-12-31T24:59:59+09:00</EventDate>

Page 71: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

65 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

<Probability>0.812</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HemsEvents> <HemsEvents> <EventType>2</EventType> <EventDate>2014-12-31T24:59:59+09:00</EventDate> <Probability>0.812</Probability> <DateUpdated>2014-12-31T24:59:59+09:00</DateUpdated> </HemsEvents> </HemsEventProperties> </HemsEventList> (2) イベント種別統計取得(実装保留)※TBD イベント種別を契約者全体で統計した情報を経客します。

Page 72: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

66 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.8 電力データ平均値情報(CollectDataAvg) (1) 電力データ平均値取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)と同一の、指定された集計方法で収集データ平均値を集計し返却します。 ・メソッド POST ・URI /hemsoption/ver1.0/CollectDataAvg/{ServiceConnectionId}.{json、または、xmlを指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・要求プロパティ(リクエストボディ) プロパティ 説明 CollectDataAvg 要求プロパティの集合です。(XML の場合に指定) CollectType 集計方法を表す文字列です。 集計方法により集計できる対象が異なります。 1:同一都道府県 2:同一市区町村 3:同一郵便番号 4:同一世帯(世帯属性) 5:同一電力プラン UnitCode 集計単位を表す文字列です。 集計単位により集計できる最大期間が異なります。 1:1時間単位(48時間以内まで集計可能) 2:1 日単位(2ヶ月(翌々月の同日)以内まで集計可能) 3:1ヶ月単位(2年(翌々年の同月)以内まで集計可能) StartTimestamp 集計期間の開始年月日時分秒です。ISO 8601 フォーマットを使用します。 EndTimestamp 集計期間の終了年月日時分秒です。ISO 8601 フォーマットを使用します。指定した年月日時分秒未満の範囲を検索します。

Page 73: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

67 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・出力パラメータ プロパティ 説明 CollectDataAvg 単位毎平均値の集合です。 CollectDataUnit 単位毎の平均値プロパティの集合です。 UnitPoint 集計ポイントを表す文字列です。 集計単位によって格納される値が異なります。 1 日単位 :年月日時(2015040100) 1時間単位:年月日(20150401) 1ヶ月単位:年月(201504) AvgValue 集計ポイント毎に集計した平均値(kWh)です。 (小数点以下第 16 位まで) ・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/CollectDataAvg/abcdefghijklmnopqrstuvwxyz123456.json ・リクエスト例[JSON の場合] (ボディ部) { "CollectType":"4", "UnitCode":"1", "StartTimestamp":"2014-07-01T00:00:00+09:00", "EndTimestamp":"2014-07-02T00:00:00+09:00" } ・レスポンス例[JSON の場合] { "CollectDataAvg":{ "CollectDataUnit": [ { "UnitPoint" : "201504010000","AvgValue" : 8 }, { "UnitPoint" : "201504010100","AvgValue" : 5 }, { "UnitPoint" : "201504010200","AvgValue" : 5 } ] } }

Page 74: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

68 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] POST /hemsoption/ver1.0/CollectDataAvg/abcdefghijklmnopqrstuvwxyz123456.xml ・リクエスト例[XML の場合] (ボディ部) <?xml version="1.0" encoding="utf-8" ?> <CollectDataAvg> <CollectType>4</CollectType> <UnitCode>1</UnitCode> <StartTimestamp>2014-07-01T00:00:00+09:00</StartTimestamp> <EndTimestamp>2014-07-02T23:59:00+09:00</EndTimestamp> </CollectDataAvg> ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <CollectDataAvg> <CollectDataUnit> <UnitPoint>201407010000</UnitPoint> <AvgValue>8</AvgValue> </CollectDataUnit> <CollectDataUnit> <UnitPoint>201407010100</UnitPoint> <AvgValue>5</AvgValue> </CollectDataUnit> (略) </CollectDataAvg>

Page 75: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

69 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.9 節電アドバイス(SavingAdvice) (1) 節電アドバイス取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)における節電アドバイスを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/SavingAdvice/{ServiceConnectionId}.{json、または、xml を指定}?NoNumber=n ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 NoNumber 節電アドバイス内容に数値表現(kWh、円)を含むんだものにするか、含んでいないものにするかを指定します。省略した場合には数値表現を含んだものを返します。 0:数値表現あり 1:数値表現なし ・出力パラメータ プロパティ 説明 SavingAdvice 節電アドバイスリソースです。 SavingInfo 節電アドバイス情報(テキスト)です。 Long 長期間(年単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:3ヶ月に 1 度 Middle 中期間(月単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:1週間に 1 度

Page 76: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

70 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

Short 短期間(日単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:毎日 ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/SavingAdvice/abcdefghijklmnopqrstuvwxyz123456.json?NoNumber=0 ・レスポンス例[JSON の場合] { "SavingAdvice": { "SavingInfo": { "Long": "今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。年間〇〇円(〇〇kWh)の節電が期待できます。", "Middle": "先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。", "Short": "昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう" } } } ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/SavingAdvice/abcdefghijklmnopqrstuvwxyz123456.xml?NoNumber=0 ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <SavingAdvice> <SavingInfo> <Long>今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。

Page 77: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

71 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

年間〇〇円(〇〇kWh)の節電が期待できます。</long> <Middle>先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。</middle> <Short >昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう</short> </SavingInfo> </SavingAdvice> (2) 節電アドバイス一覧取得 サービス連携リソースを指定せず、複数の世帯(HEMS 利用者リソース)に関する節電アドバイスを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/SavingAdvice.{json、または、xml を指定}?NoNumber=n&Page=xxx&ItemsPerPage=xxx ・入力パラメータ(URI指定) リスト形式で取得する際の入力パラメータについては、1.3.7 リスト形式を参照してください。 プロパティ 説明 NoNumber 節電アドバイス内容に数値表現(kWh、円)を含むんだものにするか、含んでいないものにするかを指定します。省略した場合には数値表現を含んだものを返します。 0:数値表現あり 1:数値表現なし ・出力パラメータ (1)節電アドバイス取得と同様のプロパティをリスト形式で返却します。 リスト形式で取得する方法については、1.3.7 リスト形式を参照してください。 プロパティ 説明 SavingAdviceList リストリソースです。

Page 78: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

72 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

SavingAdvices 節電アドバイスリソースの集合です。(XML の場合に返却) SavingAdvice 節電アドバイスプロパティの集合です。 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 SavingInfo ※(1)節電アドバイス取得と同様のプロパティ集合を返却します。 Long 長期間(年単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:3ヶ月に 1 度 Middle 中期間(月単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:1週間に 1 度 Short 短期間(日単位)での実施を促す節電アドバイス(テキスト)。最大 300 文字。 アドバイス内容の更新頻度は以下の通りです。 頻度:毎日 ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/SavingAdvice.json?NoNumber=0&Page=0&ItemsPerPage=100 ・レスポンス例[JSON の場合] { "SavingAdviceList": { "Page": 0, "TotalPages": 11, "ItemsPerPage": 100, "TotalItems": 1001, "Start": 0, "End":99, "Uri":"\/hemsoption\/ver1.0\/SavingAdvice.json?NoNumber=0&Page=0&ItemsPerPage=100", "FirstPageUri":"\/hemsoption\/ver1.0\/SavingAdvice.json?NoNumber=0&P

Page 79: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

73 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

age=0&ItemsPerPage=100", "NextPageUri":"\/hemsoption\/ver1.0\/SavingAdvice.json?NoNumber=0&Page=1&ItemsPerPage=100", "LastPageUri":"\/hemsoption\/ver1.0\/SavingAdvice.json?NoNumber=0&Page=10&ItemsPerPage=100", "SavingAdvice": [ { "ServiceConnectionId":"0123456789abcdefghij987065412312", "SavingInfo": { "Long": "今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。年間〇〇円(〇〇kWh)の節電が期待できます。", "Middle": "先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。", "Short": "昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう" } }, { "ServiceConnectionId":"abcdefghij9870654123120123456789", "SavingInfo": { "Long": "今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。年間〇〇円(〇〇kWh)の節電が期待できます。", "Middle": "先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。", "Short": "昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう" } }, (略) ] }

Page 80: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

74 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

} ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/SavingAdvice.xml?NoNumber=0&Page=0&ItemsPerPage=100 ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <SavingAdviceList> <Page>0</Page> <TotalPages>11</TotalPages> <ItemsPerPage>100</ItemsPerPage> <TotalItems>1001</TotalItems> <Start>0</Start> <End>99</End> <Uri>/hemsoption/ver1.0/SavingAdvice.json?NoNumber=0&Page=0&ItemsPerPage=100</Uri> <FirstPageUri>/hemsoption/ver1.0/SavingAdvice.json?NoNumber=0&Page=0&ItemsPerPage=100</FirstPageUri> <NextPageUri>/hemsoption/ver1.0/SavingAdvice.json?NoNumber=0&Page=1&ItemsPerPage=100</NextPageUri> <LastPageUri>/hemsoption/ver1.0/SavingAdvice.json?NoNumber=0&Page=10&ItemsPerPage=100</LastPageUri> <SavingAdvices> <SavingAdvice> <ServiceConnectionId>0123456789abcdefghij98706541231</ServiceConnectionId> <SavingInfo> <Long>今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。年間〇〇円(〇〇kWh)の節電が期待できます。</long> <Middle>先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。</middle> <Short >昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう</short>

Page 81: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

75 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

</SavingInfo> </SavingAdvice> <SavingAdvice> <ServiceConnectionId>abcdefghij987065412310123456789</ServiceConnectionId> <SavingInfo> <Long>今年の電気代は〇〇円(〇〇kWh)となっています。このまま行くと〇〇円(〇〇kWh)かかる予定です。省エネ型のエアコンへの買い替えを検討しましょう。年間〇〇円(〇〇kWh)の節電が期待できます。</long> <Middle>先月に対して今月の電気代は〇〇円(〇〇kWh)高くなっています。待機電力が〇〇円(〇〇kWh)高めなので、使用しない時には温水洗浄便座の電源を切りましょう。月間〇〇円(〇〇kWh)の節電が期待されます。</middle> <Short >昨日に対して今日の電気代は〇〇円(〇〇Wh)高くなっています。このまま行くと〇〇円(〇〇Wh)多く電気代がかかる予定です。必要のない電気機器の電源が入っていないか確認しましょう</short> </SavingInfo> </SavingAdvice> </SavingAdvices> </SavingAdviceList>

Page 82: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

76 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.10 家電(HemsControl) ※※※※TBDTBDTBDTBD (1) 家電状態取得(実装保留)※TBD デバイスリソースを指定し、現在の状態プロパティを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/HemsControl/{xxxxxxx}.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ・出力パラメータ プロパティ 説明 (2) 家電制御(実装保留)※TBD デバイスリソースを指定し、現在の状態プロパティを変更します。 ・メソッド PUT ・URI /hemsoption/ver1.0/HemsControl/{xxxxxxx}.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ・出力パラメータ

Page 83: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

77 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

プロパティ 説明 1.6.11 コンテンツ(HemsContents) ※※※※TBDTBDTBDTBD (1) コンテンツ取得(実装保留)※TBD コンテンツ IDを指定し、プロパティを返却します。 返却するコンテンツに付加されている配信グループ、配信日時等の配信条件に関わらずプロパティを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/HemsContents/{ContentsId}.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ContentsId コンテンツを識別するための文字列です。コンテンツ登録したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 StartDate 指定したコンテンツの公開開始日時を年月日時分秒で返却します。ISO 8601 フォーマットを使用します。 コンテンツ登録・更新時に指定されない場合は空が返却されます。 EndDate 指定したコンテンツの公開終了日時を年月日時分秒で返却します。ISO 8601 フォーマットを使用します。 コンテンツ登録・更新時に指定されない場合は空が返却されます。 DeliverCategory 配信グループ名称です。 コンテンツ登録・更新時に指定された名称が返却されます。 Url コンテンツ表示用の URL です。HEMS 情報基盤で提供されるコンテンツ配信機能上の WEBサーバへの URL です。

Page 84: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

78 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(2) コンテンツ登録(実装保留)※TBD 需要家向けコンテンツを API 経由で登録します。登録後、HEMS 情報基盤で採番された ContentsId を返却します。 ・メソッド PUT ・URI /hemsoption/ver1.0/HemsContents.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ・コンテンツ URL ・開始時間 ・終了時間 ・配信手段 (広告エリア、固定エリア、データ放送枠など) ・緯度経度、半径 ・静的属性 ・動的属性 等 ・出力パラメータ プロパティ 説明 ContentsId コンテンツを識別するための文字列です。コンテンツ登録したタイミングで生成されます。 (3) コンテンツ更新(実装保留)※TBD ContentsId を指定して、登録済みの需要家向けコンテンツを API 経由で更新(差し替え)します。 ・メソッド PUT ・URI

Page 85: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

79 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

/hemsoption/ver1.0/HemsContents/{ContentsId}.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ContentsId コンテンツを識別するための文字列です。コンテンツ登録したタイミングで生成されます。 ・コンテンツ URL ・開始時間 ・終了時間 ・配信手段 (広告エリア、固定エリア、データ放送枠など) ・緯度経度、半径 ・静的属性 ・動的属性 等 ・出力パラメータ (4) コンテンツ削除(実装保留)※TBD ContentsId を指定して、登録済みの需要家向けコンテンツを API 経由で削除します。 ・メソッド DELETE ・URI /hemsoption/ver1.0/HemsContents/{ContentsId}.{json、または、xml を指定} ・入力パラメータ プロパティ 説明 ContentsId コンテンツを識別するための文字列です。コンテンツ登録したタイミングで生成されます。 ・出力パラメータ

Page 86: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

80 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.12 メール(Mail) (1) メール送信 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)が設定しているメールアドレスプロパティへテキストメールを送信します。 添付ファイルは付加できません。 ・メソッド POST ・URI /hemsoption/ver1.0/Mail/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・要求プロパティ(リクエストボディ) プロパティ 説明 Mail メール送信要求プロパティ(XML の場合に指定) Subject 送信するメールの件名を設定します。 ※長さ制限について検討中※長さ制限について検討中※長さ制限について検討中※長さ制限について検討中 Message 送信するメールの本文を設定します。 ※長さ制限について検討中※長さ制限について検討中※長さ制限について検討中※長さ制限について検討中 ・出力パラメータ プロパティ 説明 SendResult 結果 Result 送信結果を以下で返却します。 メールサーバでの送信結果であり、送達を確認できる結果ではありません。 OK:正常に送信された NG:送信エラー

Page 87: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

81 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] POST /hemsoption/ver1.0/Mail/abcdefghijklmnopqrstuvwxyz012345.json ・リクエスト例[JSON の場合] (ボディ部) { "Subject ":"お知らせ", "Message":"メール本文を指定する" } ・レスポンス例[JSON の場合] { "SendResult": { "Result":"OK " } } ・リクエスト例[XML の場合] POST /hemsoption/ver1.0/Mail/abcdefghijklmnopqrstuvwxyz012345.xml ・リクエスト例[XML の場合] (ボディ部) <?xml version="1.0" encoding="utf-8" ?> <Mail> <Subject>お知らせ</Subject> <Message>メール本文を指定する</Message> </Mail> ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <SendResult> <Result>OK</Result> </SendResult>

Page 88: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

82 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.13 グローバル IPアドレス(GlobalIpAddresses) (1) グローバル IPアドレス取得 サービス連携リソースを指定し、当該世帯(HEMS 利用者リソース)のグローバル IPアドレスを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/GlobalIpAddresses/{ServiceConnectionId}.{json、または、xmlを指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 GlobalIpAddress グローバル IP アドレスプロパティの集合です。 IpAddress 世帯に設定されたグローバル IP アドレスです。(xxx.xxx.xxx.xxx) ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/GlobalIpAddresses/abcdefghijklmnopqrstuvwxyz012345.json ・レスポンス例[JSON の場合] { "GlobalIpAddress": { "IpAddress":"xxx.xxx.xxx.xxx" } }

Page 89: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

83 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] GET /hemsoption/ver1.0/GlobalIpAddresses/abcdefghijklmnopqrstuvwxyz012345.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <GlobalIpAddress> <IpAddress>xxx.xxx.xxx.xxx</IpAddress> </GlobalIpAddress> (2) グローバル IPアドレス一覧取得 アカウントリソースが参照可能なすべての当該世帯(HEMS 利用者リソース)のグローバル IPアドレスを返却します。 ・メソッド GET ・URI /hemsoption/ver1.0/GlobalIpAddresses.{json、または、xml を指定} ・入力パラメータ(URI指定) リスト形式で取得する際の入力パラメータについては、1.3.7 リスト形式を参照してください。 ・出力パラメータ グローバル IPアドレスとサービス連携 ID のペアをリスト形式で返却します。 リスト形式で取得する方法については、1.3.7 リスト形式を参照してください。 プロパティ 説明 GlobalIpAddressList グローバル IP アドレスリストリソースです。 GlobalIpAddresses グローバル IP アドレスリソースの集合です。(XML の場合に返却) GlobalIpAddress グローバル IP アドレスリソースプロパティの集合です。 IpAddress 世帯に設定されたグローバル IP アドレス (xxx.xxx.xxx.xxx)

Page 90: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

84 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS 利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/GlobalIpAddresses.json ・レスポンス例[JSON の場合] { "GlobalIpAddressList": { "Page": 0, "TotalPages": 3, "TotalItems": 7, "Start": 0, "End": 2, "FirstPageUri": "\/hemsoption\/ver1.0\/GlobalIpAddresses.json?ItemsPerPage=3&Page=0", "NextPageUri": "\/hemscommon\/ver1.0\/GlobalIpAddresses.json?ItemsPerPage=3&Page=1", "LastPageUri": "\/hemscommon\/ver1.0\/GlobalIpAddresses.json?ItemsPerPage=3&Page=2", "ItemPerPage": 3, "GlobalIpAddress": [ { "IpAddress":"xxx.xxx.xxx.xxx", "ServiceConnectionId":"1234567890abcdefghijklmnopqrstuv" }, { "IpAddress":"xxx.xxx.xxx.xxx", "ServiceConnectionId":"abcdefghijklmnopqrstuv1234567890" }, (略) ] }

Page 91: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

85 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[XML の場合] GET /hemsoption/ver1.0/GlobalIpAddresses.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <GlobalIpAddressList> <Page>0</Page> <TotalPages>3</TotalPages> <TotalItems>7</TotalItems> <Start>0</Start> <End>2</End> <FirstPageUri>/hemsoption/ver1.0/GlobalIpAddresses.xml?ItemsPerPage=3&Page=0</FirstPageUri> <NextPageUri>/hemsoption/ver1.0/GlobalIpAddresses.xml?ItemsPerPage=3&Page=1</NextPageUri> <LastPageUri>/hemsoption/ver1.0/GlobalIpAddresses.xml?ItemsPerPage=3&Page=2</LastPageUri> <ItemsPerPage>3</ItemsPerPage> <GlobalIpAddresses> <GlobalIpAddress> <IpAddress>xxx.xxx.xxx.xxx</IpAddress> <ServiceConnectionId>1234567890abcdefghijklmnopqrstuv</ServiceConnectionId> </GlobalIpAddress> <GlobalIpAddress> <IpAddress>xxx.xxx.xxx.xxx</IpAddress> <ServiceConnectionId>abcdefghijklmnopqrstuv1234567890</ServiceConnectionId> </GlobalIpAddress> (略) </GlobalIpAddresses> </GlobalIpAddressList>

Page 92: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

86 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

1.6.14 天気予報一覧(3時間値)取得(Weather) (1) 天気予報一覧(3時間値)取得 認証トークンに紐付く HEMS 利用者の属性情報を基に、その地域の現在時刻の気象情報を取得します。返却するデータは以下のデータすべてです。また、現在時刻より前のデータは実況データ、後のデータは予測データです。 ・現在日付と翌日の2日分の3時間値(0時、3時、6時、9時、12 時、15時、18時、21 時)の気象情報。 ・メソッド GET ・URI /hemsoption/ver1.0/Weather/{ServiceConnectionId}.{json、または、xml を指定} ・入力パラメータ(URI指定) プロパティ 説明 ServiceConnectionId サービス連携を識別するための 32 文字の文字列です。HEMS利用者のサービス契約時など、収集データの提供を許諾したタイミングで生成されます。 ・出力パラメータ プロパティ 説明 Weather 気象情報リストです。 TimesForecast 3時間値リストです。(XML の場合に返却) Time 時間あたりの気象情報プロパティです。 Datetime 気象情報の対象日を年月日時分秒で返却します。ISO 8601 フォーマットを使用します。 時は 00/03/06/09/12/15/18/21、分秒は 00:00固定です。 現在日と翌日の 2 日分を返却します。 Image 天気画像番号を表す 3桁の数値です。(別表参照) Temp 気温(℃)を表す数値です。 氷点下は"-1"等。 Humid 湿度(%)を表す数値です。 WindDi 風向(0:静穏、1:北の風、2:北東の風、3:東の風、4:南東の風、5:南の風、6:南西の風、7:西の風、8:北西の風)

Page 93: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

87 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

WindSp 風速(メートル/秒)を表す数値です。 Prec 降水量(ミリ)を表す数値です。 Prob 降水確率(%)を表す数値です。 ・返却する天気画像番号(Image)は以下の 31種類です。 Image の値 意味 Image の値 意味 100 晴れ 300 雨 101 晴れ時々曇り 301 雨時々晴れ 102 晴れ時々雨 302 雨時々曇り 104 晴れ時々雪 303 雨時々雪 110 晴れのち曇り 308 雨で暴風を伴う 112 晴れのち雨 311 雨のち晴れ 115 晴れのち雪 313 雨のち曇り 200 曇り 314 雨のち雪 201 曇り時々晴れ 400 雪 202 曇り時々雨 401 雪時々晴れ 204 曇り時々雪 402 雪時々曇り 210 曇りのち晴れ 403 雪時々雨 212 曇りのち雨 407 暴風雪 215 曇りのち雪 411 雪のち晴れ 413 雪のち曇り 414 雪のち雨 500 みぞれ

Page 94: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

88 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

・リクエスト例[JSON の場合] GET /hemsoption/ver1.0/Weather/abcdefghijklmnopqrstuvwxyz012345.json ・レスポンス例[JSON の場合] { "Weather" : { "Time" : [ { "Datetime":"2014-12-01T00:00:00+09:00", "Image":"100", "Temp":"12", "Humid":"45", "WindDi":"1", "WindSp":"3", "Prec":"0", "Prob":"0" }, { "Datetime":"2014-12-01T03:00:00+09:00", "Image":"100", "Temp":"14", "Humid":"45", "WindDi":"1", "WindSp":"3", "Prec":"0", "Prob":"0" }, { "Datetime":"2014-12-02T21:00:00+09:00", (略) }, (略) ] } } ・リクエスト例[XML の場合]

Page 95: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

89 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

GET /hemsoption/ver1.0/Weather/abcdefghijklmnopqrstuvwxyz012345.xml ・レスポンス例[XML の場合] <?xml version="1.0" encoding="utf-8" ?> <Weather> <TimesForecast> <Time> <Datetime>2014-12-01T00:00:00+09:00</Datetime> <Image>100</Image> <Temp>12</Temp> <Humid>45</Humid> <WindDi>1</WindDi> <WindSp>3</WindSp> <Prec>0</Prec> <Prob>0</Prob> </Time> <Time> <Datetime>2014-12-01T03:00:00+09:00</Datetime> <Image>100</Image> <Temp>14</Temp> <Humid>45</Humid> <WindDi>1</WindDi> <WindSp>3</WindSp> <Prec>0</Prec> <Prob>0</Prob> </Time> <Time> <Datetime>2014-12-02T21:00:00+09:00</Datetime> (略) </Time> (略) </TimesForecast> </Weather>

Page 96: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

90 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

2. 情報基盤コールバック API

2.1 概要 HEMS 情報基盤は管理する HEMS 利用者情報に変更があった場合、サービス事業者が提供するコールバック URL に対して HTTP POST で変更イベントの一覧を通知します。コールバックは HEMS 利用者情報の変更の通知のみを行い、変更されたデータ自体の提供は行いません。変更された HEMS 利用者情報データ自体の取得には、「1.6.1 1.6.1」の API を使用して別途取得する必要があります。 2.1.1 コールバック URL 形式 コールバック URL は、サービス事業者にて提供される URLで、URL 形式として有効であればその URL 文字列には任意のパスを指定することが可能です。 コールバック URL は、サービス事業者が提供するサービス1つに対して1つ指定することができます。 https://{任意のパス} コールバック URL は、HTTPS上での提供が必要です。 データのプライバシ保護のため、暗号化されない HTTP はサポートされません。 コールバック URL は、予め HEMS 情報基盤の設定情報として管理されます。コールバック URL を登録・変更・解除する API は提供されません。事前の構築・運用業務によってコールバック URL は HEMS 情報基盤に登録されるものとします。 2.1.2 HTTP リクエストメソッド コールバック URL に対する HEMS 情報基盤からリクエストメソッドは HTTP POSTにのみ対応しています。 2.1.3 HTTP リクエストボディフォーマット コールバック URL に対する HEMS 情報基盤からの HTTP POST のリクエストボディ部は JSON フォーマットでリクエストを送信します。 全ての JSON の形式はエンコードが UTF-8、BOM無しとなります。 改行について、本書でサンプルを記載する際は、可読性を考慮し改行をし、インデントを付与しますが、実際には改行は行わず、インデントもありません。 リクエスト内のリストは、変更が発生した順序通りに並びます。また、リスト内のプロパティは順序不同となります。

Page 97: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

91 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

2.1.4 HTTP ステータスコード サービス事業者は、HTTP コールバック URL に対する HTTP POST リクエストに対して、変更通知を正常に受信できたかを、HTTP ステータスコードを用いて成功/失敗を返却することができます。 なお、HEMS 情報基盤は 200 OK 以外の応答はすべて受信に失敗したとみなし、返却された HTTP ステータスにより再送を試みます。再送処理については後述の「2.1.7 エラー時の再送処理について」を参照してください。 特記する HTTP レスポンスの HTTP ステータスコードは以下の通りです。 •200 OK:リクエストが成功し正常に処理完了。 •400 BAD REQUEST:リクエストされた形式が正しくありません。(再送しません) •401 UNAUTHORIZED:認証エラー(再送しません) 上記以外の HTTP ステータスコードは再送を試みます。 2.1.5 通信の暗号化 コールバック URL へのアクセスは SSL(HTTPS)のみを利用します。データのプライバシ保護のため、暗号化されない HTTP はサポートしません。

2.1.6 認証方式 コールバック URLへのアクセス時には HEMS 情報基盤からの正しいアクセスであることを証明するために認証を実施することとします。 HEMS情報基盤へのAPIアクセス時と同じ方式とし認証トークンをHTTPヘッダに載せて伝達します。 コールバック URLで設定する認証トークンは以下の手順で作成するものとします。 (1).ハッシュアルゴリズム HMAC-SHA256でハッシュ化したバイナリ値を生成 以下の情報でハッシュ化したデータをバイナリ形式で取得します。 ・アルゴリズム:HMAC-SHA256 ・メッセージ:サービス事業者毎に HEMS 情報基盤から提供している、 ServiceProviderPortalId をメッセージデータとする。 ・秘密鍵:ServiceProviderPortalId に対応する Password (2). (1) で生成したバイナリ値を BASE64 形式でエンコード ・HMAC-SHA256 アルゴリズムで生成したハッシュ値(バイナリ)を、BASE64 方式 を利用して文字列化する。 (2)で生成した文字列を認証トークンとして利用します。

Page 98: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

92 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

サービス事業者のコールバック URL が呼び出された際には、サービス事業者で保持している ServiceProviderPortalId と Password を用いて、同様の手順で HMAC-SHA256ハッシュ化、BASE64 エンコードし、その文字列が HEMS 情報基盤から受け渡された認証トークン文字列と同値であることを確認することで認証を行ってください。 認証トークンを記述するヘッダ名は次の通りです。 X-Authentication-token: xxxxxxxxxxxxxxxx 2.1.7 エラー時の再送処理について HEMS 情報基盤はコールバック URL への HTTP POST リクエストに対する HTTPステータスコードが 200 OK/400 BAD REQUEST/401 UNAUTHORIZED 以外の場合、変更通知が失敗したとみなし再送処理を実行します。 再送間隔は 3秒、再送回数は 3回とします。(リリース時の初期値であり、運用状況によって変更される可能性があります)

Page 99: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

93 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

2.2 コールバック API 詳細

2.2.1 HEMS 利用者状態変更通知 サービス事業者のサービスに加入している HEMS 利用者の状態変更(サービス申込・解約・ID属性変更)が発生したことを通知します。 本通知受領後、HEMS 情報基盤の HEMS 利用者リソースへアクセスし、該当ユーザの属性情報を取得してください。 ・メソッド POST ・URI https://{任意のパス} ・要求プロパティ 要求プロパティ 説明 設定値条件 Object かならず、”ServiceUser”が指定されます。 ・以下のみを許容 - ServiceUser Entry 変更通知のリストです。 ・JSON のリスト構造 ・最大プロパティ数は15000 ServiceConnectionId 変更が発生したサービス連携IDが指定されます。 ・32 文字 ・半角英数字 Status 以下の文字列のいずれかが指定されます。 “Create”:指定されたサービス連携 ID が HEMS 情報基盤上に新規作成されたことを表します。(申込受付中) “Update”: 指定されたサービス連携 ID の ID 属性情報が変更されたことを表します。(ID 属性変更) “Delete”: 指定されたサービス連携 ID に対し、サービス解約受付されたことを表します。(解約受付中) “ForceDelete”: 指定されたサ

・以下のみを許容 – Create – Update – Delete – ForceDelete

Page 100: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

94 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

ービス連携 ID が HEMS 情報基盤上から削除され、さらに HEMS情報基盤上でサービス解約処理が完了したことを表します。(強制解約) TimeStamp 変更が発生した日時を表します。ISO8601 フォーマットで年月日時分秒を表します。 ・「1.3.6 日付と時刻」に従う 応答プロパティ 説明 設定値条件 なし - - ・リクエスト例[JSON] { "Object":"ServiceUser", "Entry": [ { "ServiceConnectionId":"1234567890abcdefghijklmnopqrstuv", "Status":"Create", "TimeStamp":"2014-11-14T12:40:52+09:00" }, { "ServiceConnectionId":"1239567890abcdefghijklmnopqrstuv", "Status":"Create", "TimeStamp":"2014-11-14T12:40:53+09:00" } ] }

Page 101: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

95 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

参考 1. REST リソースの想定用途

A.認証トークン要求~API 起動 HEMS 情報基盤が提供する API を利用するために必須となる認証トークンを要求する API の利用例です。HEMS 情報基盤を利用するサービス事業者へ事前に通知されるサービスプロバイダ ID とパスワードによって要求し、HEMS 情報基盤が有効なものと確認した場合に認証トークンを発行します。 ・認証トークン要求からサービス事業者向け API 起動

Page 102: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

96 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

B.HEMS 利用者情報変更通知(サービス契約)~サービス状態変更 需要家が HEMS 情報基盤へサービス利用申し込みを行った際、HEMS 情報基盤はサービスを提供するサービス事業者へその通知を行うことができます(2. 情報基盤コールバック API)。 また、サービス事業者で変更通知を受け取らずに HEMS 情報基盤内で完了することも可能です。その際は強制的に加入状態が変更されます。 ・HEMS 利用者情報変更通知を利用する場合 ・HEMS 利用者情報変更通知を利用しない場合

需要家から HEMS 情報基盤へサービス利用申し込みの「受付」が完了した時点で、需要家属性情報等をサービス事業者への提供が可能となります。

Page 103: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

97 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

C.HEMS 利用者情報変更通知(サービス解約)~サービス状態変更 需要家が HEMS 情報基盤へサービス解約申し込みを行った際、HEMS 情報基盤はサービスを提供するサービス事業者へその通知を行うことができます(2. 情報基盤コールバック API)。 また、サービス事業者で変更通知を受け取らずに HEMS 情報基盤内で完了することも可能です。その際は強制的に加入状態が変更されます。 ・HEMS 利用者情報変更通知を利用する場合 ・HEMS 利用者情報変更通知を利用しない場合

HEMS情報基盤で「サービス解約完了」した時点で、需要家属性情報等のサービス事業者への提供を停止します。

Page 104: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

98 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

D.HEMS 利用者情報変更通知(情報基盤解約)~サービス状態変更 需要家を HEMS 情報基盤から解約させた場合、HEMS 情報基盤はサービスを提供するサービス事業者へその通知を行うことができます(2. 情報基盤コールバック API)。 また、サービス事業者で変更通知を受け取らずに HEMS 情報基盤内で完了することも可能です。その際は強制的に加入状態が変更されます。 ・HEMS 利用者情報変更通知を利用する場合 ・HEMS 利用者情報変更通知を利用しない場合

HEMS情報基盤で「情報基盤解約完了」した時点で、需要家属性情報等のサービス事業者への提供を停止します。

Page 105: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

99 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

E.HEMS 利用者情報変更通知(需要家属性)~変更反映 需要家が HEMS 情報基盤内で保有する属性情報(住所、電話番号等)を変更した場合、HEMS 情報基盤はサービス事業者へその通知を行うことができます(2. 情報基盤コールバック API)。 また、サービス事業者で変更通知を受け取らずに HEMS 情報基盤内で完了することも可能です。

Page 106: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

100 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

参考 2. HEMS 重点 8機種からの収集プロパティ CollectData リソースに設定されるプロパティと EPC 一覧を示します。 (1) スーパークラス(全機器の共通プロパティ) 収集プロパティ(日本語名) EPC 動作状態 0x80 設置場所 0x81 規格 Version 情報 0x82 異常発生状態 0x88 メーカーコード 0x8A 現在時刻設定 0x97 現在年月日設定 0x98 状変アナウンスプロパティマップ 0x9D Set プロパティマップ 0x9E Get プロパティマップ 0x9F (2) スマート電力量メーター(0x0288) HEMS-スマートメーター(Bルート)運用ガイドライン[第1.0版](案)からの抜粋です。 収集プロパティ(日本語名) EPC 積算電力量有効桁数 0xD7 積算電力量計測値(正方向計測値) 0xE0 積算電力量単位(正方向、逆方向計測値) 0xE1 積算電力量計測値履歴1(正方向計測値) 0xE2 積算電力量計測値(逆方向計測値) 0xE3 積算電力量計測値履歴1(逆方向計測値) 0xE4 積算履歴収集日1 0xE5 瞬時電力計測値 0xE7 瞬時電流計測値 0xE8 定時積算電力量計測値(正方向計測値) 0xEA 定時積算電力量計測値(逆方向計測値) 0xEB

Page 107: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

101 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(3) 住宅用太陽光発電(0x0279) HEMS-太陽光発電運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 瞬時発電電力計測値 0xE0 積算発電電力量計測値 0xE1 (4) 蓄電池(0x027D) HEMS-蓄電池運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 運転モード設定 0xDA 蓄電残量1 0xE2 蓄電残量2 0xE3 蓄電残量3 0xE4 蓄電池タイプ 0xE6 運転動作状態 0xCF (5) 燃料電池(0x027C) HEMS-燃料電池、ガス・石油給湯器運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 瞬時発電電力計測値() 0xC4 積算発電電力量計測値() 0xC5 (6) 電気自動車充放電器(0x027E) HEMS-EV/PHV電気自動車用充放電器運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 車載電池の放電可能容量値1 0xC0 車載電池の放電可能容量値2 0xC1 車載電池の放電可能残容量1 0xC2 車載電池の放電可能残容量2 0xC3 車載電池の放電可能残容量3 0xC4 定格充電能力 0xC5

Page 108: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

102 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

定格放電能力 0xC6 車両接続・充放電可否状態 0xC7 最小最大充電電力値 0xC8 最小最大放電電力値 0xC9 最小最大充電電流値 0xCA 最小最大放電電流値 0xCB 車載電池の使用容量値1 0xD0 車載電池の使用容量値2 0xD1 運転モード設定 0xDA 車載電池の電池残容量1 0xE2 車載電池の電池残容量2 0xE3 車載電池の電池残容量3 0xE4 (7) 家庭用エアコン(0x0130) HEMS-エアコン運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 運転モード設定 0xB0 温度設定値 0xB3 節電動作設定 0x8F 室内温度計測値 0xBB 風量設定 0xA0 (8) 一般照明(0x0290) HEMS-照明機器運用ガイドライン [第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 点灯モード設定 0xB6 (9) 電気温水器(0x026B) HEMS-HP給湯機運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 沸き上げ自動設定 0xB0 昼間沸き増し許可設定 0xC0 給湯中状態 0xC3

Page 109: HEMS情報基盤 サービス事業者向け API仕様書...2015/06/02  · Ç syx srsÇ M Ô N Ç U xtr vstÇ M Ç FF5Ç # Ç"väÇ M Ç =Ç # Ç t w vÇ M Ç Ç Q# ( . Ç Q3R 3ï

103 C o p y r i g h t ( c ) 2 0 1 4 K D D I 株 式 会 社

(10) 瞬間式給湯器(0x0272) HEMS-燃料電池、ガス・石油給湯器運用ガイドライン[第 1.1 版]からの抜粋です。 収集プロパティ(日本語名) EPC 給湯器燃焼状態 0xD0 風呂給湯器燃焼状態 0xE2 風呂自動モード設定 0xE3 (11) 分電盤メータリングクラス(0x0287) ECHONET 機器オブジェクト詳細規定 [Release F]からの抜粋です。 重点 8機種には含みませんが、CTクランプからの収集データは当クラスに準拠して収集します。 収集プロパティ(日本語名) EPC 積算電力量計測値(正方向) 0xC0 積算電力量計測値(逆方向) 0xC1 積算電力量単位 0xC2