エネがえるAPIを使用して独自のアプリケーションを開発いただくにあたって、参考情報としてエネがえるASP の内部構造について解説します。
●エネがえるASPの内部構造について
通常、エネがえるAPIとして導入企業様にご提供しているのは右上の「一般用API」 となります。
このAPIは指定された入力値に基づき計算結果を都度返すのみです。当社サーバ側では、入力データや計算結果のデータ保存は原則として行っていません。
また、シミュレーションで得られた使用量から料金計算を行ったり、複数の結果を比較して効果額を計算したりするのは APIを呼び出すクライアント側での処理になります。
(ブラウザ上、サーバー上などの動作場所によらず)
エネがえるAPIを使用して独自のアプリケーションを開発いただく場合はこういったフロントサイド側の機能実装・開発が必要となります。(上図のオレンジ色で囲った部分)
●API実行における認証情報(実行ユーザー)の割り当てについて
以下の図のようになります。エネがえるASP(当社のサービスの場合)と、独自アプリケーションでは次のように異なっており、APIを呼び出すプログラムの稼働場所が異なります。
上記の構造をご理解いただき、開発が必要な部分を見極めてください。
認証トークンについて
ログインで取得した認証トークンは同じユーザーが新規にログインを行うと無効となりますので、APIユーザーは他の場所で使用しないでください(管理用には別のASPユーザーをご使用ください)。
また、エネがえる側のメンテナンス・不具合などで認証トークンが無効化される場合がありますので、API実行時に認証エラー(403: Forbidden)が発生した場合は再ログインを行い認証トークンを再取得するようプログラムしてください。
●エネがえるAPIを使った独自アプリケーションの構成例
以下は、あくまで一例としてご参照ください。貴社の活用目的や必要なユーザー体験に応じて構成をご検討ください。ご相談は当社営業まで遠慮なくご連絡ください。
エネがえるAPIサービスを用いて、自社独自のWebアプリケーションを開発したいという場合は、info@enegaeru.comまでお気軽にお問い合わせください。