処理カスタマイズAPI - 共通パラメーター

トップ＞開発をする方向け＞処理カスタマイズAPI

処理カスタマイズAPI - 共通パラメーター

共通パラメーター

すべての処理カスタマイズAPIにて共通して渡される引数の一覧です。

全処理共通の項目

shop_id

店舗を一意に特定するID（ebisumartNo）が入ります。

function_name

処理カスタマイズAPIの名前です。

flow_name

処理フローの名前です。

/customize_apisにて処理カスタマイズAPIを登録する際、
API_VERSIONに設定した値もしくは、リクエストヘッダの
X-EBISU-API-VERSIONの値によってflow_nameの値が変わります。

API_VERSIONに設定可能な値は1または2になります。デフォルトのAPI_VERSIONは1です。

user_agent

ブラウザから送られてきたユーザーエージェントの値です。

request

ブラウザから送られてきたリクエストパラメーター「REQUEST」の値です。その画面において行う処理の種類に応じた文字列（例えば検索時は「search」、編集時は「edit」など）が入ります。

process_mode

処理モードを示すIDです。入力画面での判定に使用してください。入力画面以外では正確な値が取れない可能性があります。common/*のように処理モードが無い処理もあり、その場合nullになります。

0:登録
1:変更
2:削除
3:照会
4:入力確認

execute_datetime

ebsiumartシステムがAPIを送信した時間です。

is_vpc

新環境からのリクエストであるときにtrueが設定されます。

ユーザWEBの処理に関する項目（ユーザWEB以外の処理でも値は送られます）

member_id: 現在ログイン中の会員のIDです。会員ログイン中の場合にのみ値が設定されます。それ以外の場合はnullとなります。
member_rank: 現在ログイン中の会員の会員ランクNoです。会員ランクオプションを利用している店舗において、会員ログイン中の場合にのみ値が設定されます。それ以外の場合はnullとなります。
remote_address: ebisumartサーバにそのリクエストを送ったクライアントのIPアドレスです。
request_root_url: リクエストのルートURLです。通常はドメイン部分になります。本番ドメインが使用される前だと、ドメイン（service.ebisumart.com等）/店舗Noの値が送れられます。
service_url: サービスURL（ユーザWEBのURLとして有効なURL）として設定されているURLの一つが送られます。ユーザアクセスのあったドメインによらず、サービスURL1が固定で返されます。
マルチドメインで動作している店舗で、ユーザアクセスのあったドメインを使用したい場合にはrequest_root_urlのドメインを使用してください。
cart_first_time_teiki_discount: 定期割引設定オプション有効時のみ送られます。カート内の商品に定期初回割引が適用されている時はtrue, それ以外の場合は falseとなります。
is_preview_mode: プレビューモードか否かが送付されます。ショップ管理画面の「プレビューを確認」ボタン経由で表示している場合はtrueとなります。ショップ管理画面の「ビューを確認」ボタン経由で表示している場合、およびショップ管理画面を経由せずに直接表示している場合はfalseとなります。
is_all_page_https_option_on: 全ページHTTPSオプションが有効にtrueが設定されます。

ショップ管理ツールの処理に関する項目（ショップ管理ツール以外の処理でも値は送られます）

admin_user_id: 現在ログイン中の管理者ユーザーIDです。ショップ管理ツールにてログイン中の場合にのみ値が設定されます。それ以外はnullとなります。
admin_user_name: 現在ログイン中の管理者ユーザー名です。ショップ管理ツールにてログイン中の場合にのみ値が設定されます。それ以外はnullとなります。
role_id: ショップ管理ツールのログインユーザのロールのIDです。ショップ管理ツールの処理では無ければnullが設定されます。
corporation_id: BtoBオプションが有効時のみ送られます。法人IDです。

OPTION_PARAMSについて

/customize_apisにて設定可能な項目にOPTION_PARAMSという項目があります。
元々処理カスタマイズAPIでは共通パラメータとしてcontextに一定の内容が送付されるように設定されていますが、
このOPTION_PARAMSへ特定の文字列を設定すると、contextに追加で情報が送付されるようになります。

例えばcontextにAPI実行時のリファラを追加したい場合、OPTION_PARAMSへrefererという文字列を指定する必要があります。
上記の指定をする場合、次のような形で指定が可能です。

POST /customize_apis.json

[body内容例]
{
	"FLOW_NAME":"*",
	"NAME":"hogehoge",
	"URL": "https://example.com/sample.json",
	"OPTION_PARAMS":"referer"
}

また、OPTION_PARAMSへ複数指定したい場合は次のような形でカンマ区切りで指定可能です。

POST /customize_apis.json

[body内容例]
{
	"FLOW_NAME":"*",
	"NAME":"hogehoge",
	"URL": "https://example.com/sample.json",
	"OPTION_PARAMS":'"referer","request_path","client_config:SITE_TITLE,SITE_NAME"'
}

なお、login_member_infoやclient_configで取得する内容はデータアクセスAPIでも取得可能ですが、
OPTION_PARAMSはデータアクセスAPIを実行することなく情報を取得することができるため、
基本的にGETのみ必要な状況であればOPTION_PARAMSを利用することをお勧めします。

※一部OPTION_PARAMSが対応していない処理カスタマイズAPIもあります。

OPTION_PARAMSに設定可能な値一覧

login_member_info

ログイン中の会員の指定された情報を送付します。
指定方法は次の形になります。

login_member_info:MEMBER.[カラム名]
例）"login_member_info:MEMBER.FREE_ITEM1,MEMBER.L_NAME"

指定可能なカラムは こちら を参考にしてください。
※なお、一部利用できないカラムもあります。

client_config

指定した店舗設定の情報を送付します。
指定方法は次の形になります。

client_config:[設定ID]
例）"client_config:SITE_TITLE,SITE_NAME"

指定可能なカラムは こちら を参考にしてください。
また、Appsにて追加した初期設定も指定が可能です。

object_data

処理中のデータを送付します。
実行する処理カスタマイズAPIによって送付される値は異なります。

cart_subtotal

現在のカート内商品の小計金額及び消費税額を送付します。
このOPTION_PARAMSを指定した場合、次の2つの値が送付されます。

cart_subtotal: 現在カートに入っている商品の小計金額です。
cart_subtotal_tax: 外税の場合に、現在カートに入っている商品に対する消費税額が送付されます。内税の場合は"0"となります。

cart_shipping_fee

現在のカート内商品の送料を送付します。

cart_shipping_fee_multiple_shipping

現在のカート内商品の送料を送付します。
複数配送先が設定されている場合、合算した値を送付します。

cart_point

現在のカート内商品によって加算されるポイントを送付します。

encode_query_string

ebisumartへのリクエストのquery部分を、指定された文字コードでデコードした文字列を送付します。
指定方法は次の形になります。

encode_query_string:[文字コード]
例）encode_query_string:UTF-8

is_smartphone_template

現在表示中のテンプレートがスマートフォンかどうかをtrueまたはfalseで送付します。
なお、テンプレートに遷移した後でないと有効な結果を返しません。

point_by_campaign_beyond

現在のカート内商品の拡張版セールスキャンペーンオプションによる付与ポイントを送付します。

discount_by_campaign_beyond

現在のカート内商品の拡張版セールスキャンペーンオプションによるキャンペーン割引額を送付します。

discount_by_bundle_sale

現在のカート内商品のまとめ買いオプションによるまとめ買い割引額を送付します。

clear_error_messages

発生するエラーメッセージを送付します。
こちらを利用する場合、エラーメッセージはクリアされます。

item_image_url

商品画像URLを送付します。

referer

リファラを送付します。

request_path

リクエストされたURLを送付します。

is_admin

SKサーバーからのアクセスかどうかをtrueまたはfalseで送付します。

client_terminal_info

リクエストヘッダのUserAgentを元に、アクセスされた端末情報を送付します。
このOPTION_PARAMSを指定した場合、次の5つの値が送付されます。

is_mobile: 携帯端末からアクセスされた場合にtrueが入ります。
is_pc: PCからアクセスされた場合にtrueが入ります。
is_robot: botからアクセスされた場合にtrueが入ります。
is_smartphone: スマートフォンからアクセスされた場合にtrueが入ります。
is_tablet: タブレットからアクセスされた場合にtrueが入ります。
is_mobile_app: ebisu mobileからアクセスされた場合にtrueが入ります。

処理カスタマイズAPI - 共通パラメーター | サポートサイト

開発者向けサポート