API実行プラグイン(Free版)

こちらはAPI実行プラグイン(Basic版)の機能限定版となっております。
API実行プラグイン(Basic版)はこちら

ユーザ操作や、画面遷移を契機にAPIを実行することができます。
発行するHTTPリクエストの、リクエストヘッダや、リクエストボディをTwig形式で記述でき、自由に設定することができます。
レスポンスに応じた処理も、Twig形式で記述でき、自由に設定することができます。
HTTPリクエストと、HTTPレスポンスの内容をログに出力し、実行結果を確認することができます。

・以下のEC-CUBEのフックポイントをAPIの実行タイミングとして設定できます。
→フロント画面から新規会員登録を申請(仮登録)したタイミング
→管理画面から会員登録・編集を行ったタイミング
→フロント画面から「ショッピングカート画面」を表示したタイミング

画像では、「フロント画面から新規会員登録を申請(仮登録)したタイミング」を設定しています。

・実行するAPIのURLを設定できます。
・HTTPメソッドは「GET」と「POST」が使用できます。
・リクエストヘッダは、ヘッダ名、ヘッダ値とも自由に設定できます。

・「ボディ」をTwigで記述することにより、EC-CUBEのデータなどリクエストに設定することができます。
画像では、新規会員登録情報から、住所を設定しています。
・「レスポンス処理」をTwigで記述することにより、レスポンス内容を加工したり、データベースに登録することができます。
画像では、JSON形式に変換してログに出力しています。

・「リクエスト1」の実行結果(レスポンス)をTwig形式で記述することにより「リクエスト2」に反映できます。
画像では、レスポンス情報から、緯度と経度を設定しています。

・Free版で設定可能な「API実行設定」は1つのみです。
・「有効・無効」項目でAPIの状態を確認できます。
・APIの「編集」操作が行えます。
※マスター画面では「有効・無効」の切り替えはできません。
※Free版では「複製」及び「削除」操作は行えません。

リクエスト1の実行結果(HTTPステータスコード)が、200番台の場合にのみ、リクエスト2を実行します。
「EC-CUBE本体をカスタマイズしている」もしくは「他のプラグインを利用している」場合、当プラグインと競合してしまい正常に機能しない可能性があります。
EC-CUBE本体のバージョンアップに伴いAPIに設定しているイベント名・プロパティが変更されることがあります。

EC-CUBE3.0.15に対応した、API実行プラグイン(Free版)をリリースしました。