開発者向けサポート

処理カスタマイズAPI関連

処理カスタマイズAPIを登録・解除することができます。

リソース一覧

リソースURI 説明
処理カスタマイズ一覧
処理カスタマイズ

リソース属性

このリソースが持つ属性を以下に示します。本リソースについてのAPIを実行すると、以下の属性を取得、変更することができます。

カラム名必須Byte型概要
API_OUT_ID〇8半角数値処理カスタマイズAPIを一意にする識別子です。
FLOW_NAME〇200半角文字列処理カスタマイズAPIを実行する処理フロー名です。指定した処理フローの場合しか処理カスタマイズAPIは実行されません。実行したい処理フローが、すべての処理の場合*、ユーザWEBすべての処理の場合userweb/*、ショップ管理画面すべての処理の場合admin/*を指定することできます。
NAME〇200半角文字列処理カスタマイズAPIのメソッド名です。メソッドの後ろに/after、/beforeを付けてください。メソッドの後ろに/afterを付けると、標準処理の実行後、Appsの処理が呼び出されます。メソッドの後ろに/beforeを付けることにより、Appsの処理によってebisumartの処理を上書きすることができます。
RETURN_VALUE1000000全角文字列固定値を返す処理の場合に返す値を指定します。値はJSON形式です。
URL200半角文字列Appsの呼び出し先URLです。例：http://support.ebisumart.com/order_update_committed.json
API_ORDER8半角数値APIの実行順序がある場合に指定します。数字が若い方から実行されます。
SYNC_KBN1半角数値標準処理からAppsを呼び出す際に同期か非同期かを示します。1:同期、0：非同期
TIMEOUT8半角数値API呼び出しのタイムアウト時間（ミリ秒）です。0（無制限）の指定はできません。未指定の場合、タイムアウト時間は120000ミリ秒（2分）となります。
OPTION_PARAMS1000000半角文字列処理カスタマイズAPI送信の際に通常は送信しない情報の送信を指定する場合に使用します。
API_VERSION4半角数値処理カスタマイズのバージョンを指定します。未指定の場合はリクエストヘッダのX-EBISU-API-VERSIONの値が入ります。
RETRY_COUNT2半角数値入力されている値がnullか0でなければその数値分リトライを実行します。上限は10回になります。