処理カスタマイズAPI

概要

えびすマートが動作するうえで必要な主要ロジックに対して、その処理前・処理後にアプリのインターフェースを呼び出すことができます。

カスタマイズする処理、および呼び出し先のインターフェースの情報は、事前にデータアクセスAPIを用いて設定しておく必要があります。

リクエスト

えびすマートからAPIを呼び出す時には、リクエストボディにJSON形式で以下の情報が送られます。

arg
該当する処理に渡される引数を要素に持つ構造体です。具体的な引数の名前とその意味は、下記一覧からたどれる各処理のドキュメントを参照してください。
requestParams
ブラウザから送付されたリクエストパラメーターが格納されます。 ただし、この情報が格納されるのは一部の処理カスタマイズAPIに限られます。対象となる処理カスタマイズAPIでは、その詳細説明ページにて「ブラウザから送付されたリクエストパラメーターがrequestParamsに格納されて送られてきます。」と記載してあります。
context
全処理共通で渡される引数を要素に持つ構造体です。具体的な引数の名前とその意味は、共通パラメーターのドキュメントを参照してください。
cart
その時点でカートに入っている商品の情報です。
session
同一セッション内にて、以前の処理カスタマイズAPI呼び出しのレスポンスで指定したセッション情報がある場合、その情報を表すマップが入ります。
current_result
処理後に呼ばれる場合にのみ含まれる内容です。えびすマートの標準ロジックによって処理した結果の値が入っています。 ただし、すでに他のAPI呼び出しによって上書きされている場合、その上書きされた値が入ります。
originalArg
argに含まれる引数の値が、他の処理カスタマイズAPI呼び出しによって既に書き換えられていた場合に、書き換え前の値が含まれます。

具体的に渡されてくるデータのサンプルは以下の通りです。

{    "arg": {        "parameter_1": "value_1"        "parameter_2": "value_2"    },     "cart": [        {            "ADD_POINT": null,             "ADD_POINT_RATE": null,             "CANCEL_SERIAL_HIKIATE_FLG": null,             "CART_COMMENT": null,             "DISCOUNT_FLG": null,             "HAISO_ID": null,             "HAISO_OMOMI": null,             "ITEMPROPERTY_LIST": "0",             "ITEM_CD": "ITEM02",             "ITEM_DOWNLOAD": null,             "ITEM_ID": "2",             "ITEM_IMAGE1": null,             "ITEM_ITEMPROPERTY_CD": "ITEM02",             "ITEM_NAME": "テスト商品2",             (省略)        }    ],     "session": {    	"error_count": "1"    },    "currentResult": true,     "originalArg": {},    "request": {}}
レスポンス

アプリでの処理を完了したのち、JSON形式で以下の内容をレスポンスボディに入れてください。

result
処理結果です。えびすマート本体による標準ロジックの結果を上書きしたい場合に設定してください。上書きしない場合はこの値を含めないでください。 処理前のAPIにてこの値が設定されていた場合、標準ロジックの呼び出しがスキップされこの値が結果として返されます。 処理後のAPIいてこの値が設定されていた場合、標準ロジックの実行結果がこの値で上書きされます。 いずれの場合も、後続のほかのAPI呼び出しによってさらに結果が上書きされる場合もあります。
messages
画面に表示したいメッセージのリストです。えびすマート本体の標準ロジックにて設定されたメッセージに加えて、指定されたメッセージが表示されるようになります。 複数のAPI呼び出しにてそれぞれメッセージが指定されていた場合、そのすべてが画面に表示されます。 各メッセージは以下のフィールドを持つオブジェクトです。
message
メッセージ
level
メッセージのレベル(1:エラー、2:警告、3:情報)
session
セッションに格納する情報。ここで指定した情報は、同一セッション内で呼び出される処理カスタマイズAPI呼び出しのリクエストに格納されます。

レスポンスのサンプルは以下の通りです。

{    "result": true,    "messages": [        {            "message": "入力項目にエラーがあります。",            "level": 1        }    ],    "session": {    	"error_count": "1"    }}		

処理フロー一覧

画面遷移時に行われる処理フローの一覧です。各フローの詳細ページには、実際にカスタマイズ可能なAPI一覧が説明されています。

(この一覧は現在作成中です。随時拡充していきます。)

ユーザWEB
ショップ管理ツール
その他

画面レンダリング時の処理

画面のレンダリング時にm:id経由で呼び出されるAPIの一覧です。

(この一覧は現在作成中です。随時拡充していきます。)

  • 利用中決済一覧取得 common/get_payment_types

    利用可能な決済種別の一覧を取得します。

    この処理を呼び出すm:idはLOOP_KESSAIです。

  • 配送方法ID取得 userweb/cart/get_shipping_type_ids

    利用可能な配送方法IDのリストを返します。

    この処理を呼び出すm:idはLOOP_HAISOです。

この説明は参考になりましたか?

はい いいえ

0人の方が「参考になった」と言っています。
0人の方が「参考にならなかった」と言っています。