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

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

※登録した「API呼び出し設定」をcronタスクより呼び出して実行することもできます。
※無料お試し版はこちら。
>>API実行プラグイン(Free版)

・EC-CUBEのフックポイントを契機に、外部APIを実行できます。
・1つの「API呼び出し設定」につき、HTTPリクエストは2本まで設定できます。

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

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

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

・「API呼び出し設定」は5個まで登録できます。
・APIの「編集」/「複製」/「削除」の操作が行えます。
※マスター画面では「有効・無効」の切り替えはできません

【注意事項】

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

【免責事項】

本プラグイン(API実行プラグイン:APIExecuterBasic)の作成には細心の注意を払っておりますが、本プラグインの使用により生じたあらゆる損害等について、理由の如何に関わらず有限会社ナインポイント(当社)は一切の責任を負いません。
ご利用に際しては、お客様にて十分に動作確認を行った後にご利用ください。
また、本プラグインの仕様に関して動作を保証するものではありません。

API登録時の処理高速化を行いました。
特定の「トリガー」を指定すると登録ができない不具合を修正致しました。

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