データアクセスAPI
概要
データアクセスAPIはREST形式のAPIです。データアクセスAPIを使用することにより、ebisumartのリソース（商品情報や会員情報など）にアクセスすることができます。APIの詳細につきましては、機能分類の各リソースのページをご確認ください。
※データアクセスAPIでは、OAuthを用いて認証を行います。具体的な手順については、Appsのインストールをご覧ください。
また、このAPIを利用した実例について、 Apps活用事例 にて掲載しておりますので、こちらの内容と併せてご覧いただけますと幸いです。
ebisumartのリソース構造
バージョンコントロール
データアクセスAPIのリクエストのヘッダ「X-EBISU-API-VERSION」にバージョンの指定が
必須
です。
「X-EBISU-API-VERSION」に1を指定して頂きますようお願いします。
アクセスURL
- 本番環境
-
service-api-{ebisumartNo}.ebisumart.com
- 命名規則
-
・ebisumartNoを小文字で設定
・アンダースコア(_)がついている場合は省略する
- 例：ebisumartNoが「TEST_EBISU-1」の店舗がデータアクセスAPIで会員情報を取得する場合
- https://service-api-testebisu-1.ebisumart.com/dataaccess/members.json
- 本番検証用環境
-
service-api01.ebisumart.com/{EBISUMART_NO}
- 命名規則
-
・ebisumartNoを大文字で設定
・アンダースコア(_)がついている場合は省略しない
- 例：ebisumartNoが「TEST_EBISU-2」の店舗がデータアクセスAPIで会員情報を取得する場合
- https://service-api01.ebisumart.com/TEST_EBISU-2/dataaccess/members.json
- デモ環境
-
demo-service-api.ebisumart.com/{EBISUMART_NO}
- 命名規則
-
・ebisumartNoを大文字で設定
・アンダースコア(_)がついている場合は省略しない
- 例：ebisumartNoが「TEST_EBISU-3」の店舗がデータアクセスAPIで会員情報を取得する場合
- https://demo-service-api.ebisumart.com/TEST_EBISU-3/dataaccess/members.json
※一部命名規則に沿っていないURLを利用している店舗が存在します。詳細はお問い合わせください。
注意
-
更新時にデータをクリアしたい場合には""（空文字）を指定していただくようお願いします。それによってデータとしてはnullが設定されます。
登録、更新時にnullを指定した場合には"null"という文字列として扱われます。
機能分類
提供する機能は下記に分類されます。詳細については下記のリンク先をご覧ください。
- 仕入先関連
- メール管理関連
- 事業所関連
- ebisumart APIログ関連
- セールスキャンペーン関連
- クーポン関連
- バッチ処理ログ関連
- ユーティリティ関連
- 会員関連
- 受注排他制御関連
- 商品セット関連
- 決済連携ID履歴関連
- ショップ管理利用者関連
- 決済方法関連
- お問い合わせ関連
- 管理画面カスタマイズ関連
- 消費税関連
- バリエーション関連
- 受注時決済ログ関連
- トランザクション関連
- メールフォーマット関連
- 配送方法関連
- 法人関連
- ランキング関連
- ノベルティ商品関連
- アクセスレポート関連
- ファイル管理関連
- メッセージリソース関連
- 受注関連
- 商品シリアル関連
- 商品関連
- メール配信ステータス関連
- バスケット分析データ関連
- 広告媒体関連
- 店舗設定関連
- 都道府県関連
- ウィッシュリスト関連
- まとめ買い割引関連
- 在庫関連
- 会員ランク関連
- 自動お知らせ設定関連
- 検索条件関連
- 外部連携トランザクション関連
- 追加テーブル関連
- タイムセール関連
- サービスURL関連
- 請求先関連
- カテゴリ関連
- メニュー関連
- フォーム定義関連
- システムHTMLフォーム定義関連
- 住所関連
- アドレス帳関連
- メールマガジン会員関連
- トピックス関連
- ショップカレンダー関連
- メール確認一時関連
- 処理カスタマイズAPI関連
- トピックスカテゴリ関連
- 通貨関連
共通パラメータ
query(検索条件)の指定方法
データアクセスAPIのパラメータとしてquery(検索条件)を指定可能な場合、以下の定義に従い検索条件を指定することができます。
- operator
- 以下のいずれかを指定してください。
- equals
- 等号による比較を行います。
- in
- columnにカラム名を指定し、valueにリストの形式で複数の候補値を指定して、候補値に一致する値があるか比較を行います。
- is_null
- nullであるか比較を行います。
- like
- likeによる比較を行います。
- less_than
- <による比較を行います。
- less_than_equals
- <=による比較を行います。
- more_than
- >による比較を行います。
- more_than_equals
- >=による比較を行います。
- and
- 複数の検索条件のandを行います。
- or
- 複数の検索条件のorを行います。
- not
- 検索条件にnotを指定します。検索条件が複数指定された場合、条件はNOT(検索条件1 AND 検索条件2 AND …)のようになります。
- column
- カラム同士の比較が必要な場合に指定します。
- column
- カラム名を指定してください。
- column_prefix
- カラムの接頭辞が指定できます。
- column_postfix
- カラムの接尾辞が指定できます。
- coalesce
- SQLのcoalesce(column, ?)の?部分を指定します。
- operand
- operatorがand, or, notのいずれかの場合、ここに検索条件を指定します。
operatorがequals、like、less_than、less_than_equals、more_than、more_than_equalsの場合、operatorがcolumnのjsonデータを指定できます。 - to_char_format
- columnの値を文字列に変換したい場合に、そのフォーマット文字列を指定します。
例えば、columnの値が日付である場合、YYYY/MM/DDのように指定します。
時刻まで指定したい場合は、YYYY/MM/DD HH24:MI:SSのように指定します。 - lower_or_upper
- lowerまたはupperを指定します。検索時に指定したカラムの値をlowerまたはupperして比較します。
- value
- 比較対象の値を指定します。
例：検索条件として"FREE_ITEM1 = 'aaa' and FREE_ITEM2 is null"を指定したい場合、以下の配列形式のJSONを指定します。
[
{
"operator":"and"
"operand":[
{
"column":"FREE_ITEM1",
"operator":"equals",
"value":"aaa"
},
{
"column":"FREE_ITEM2",
"operator":"is_null",
}
]
}
]
例：検索条件として"FREE_ITEM1 = 'aaa' or FREE_ITEM2 is null"を指定したい場合、以下の配列形式のJSONを指定します。
[
{
"operator":"or"
"operand":[
{
"column":"FREE_ITEM1",
"operator":"equals",
"value":"aaa"
},
{
"column":"FREE_ITEM2",
"operator":"is_null",
}
]
}
]
例：検索条件としてREGIST_DATEまたはUPDATE_DATEが2023/01/01 00:00:00以降という条件で指定したい場合、以下の配列形式のJSONを指定します。
[
{
"operator":"or"
"operand":[
{
"column":"REGIST_DATE",
"operator":"more_than_equals",
"to_char_format":"YYYY/MM/DD HH24:MI:SS",
"value":"2023/01/01 00:00:00"
},
{
"column":"UPDATE_DATE",
"operator":"more_than_equals",
"to_char_format":"YYYY/MM/DD HH24:MI:SS",
"value":"2023/01/01 00:00:00"
}
]
}
]
search_order(検索結果の順序)の指定方法
データアクセスAPIのパラメータとしてsearch_order(検索結果の順序)を指定可能な場合、以下の定義に従い検索結果の順序を指定することができます。
- column
- ソート対象のカラムを指定します。
- nulls_last
- trueを指定するとcolumnで指定したカラムの値がnullのものを末尾に表示させます。
- sort_desc
- trueを指定すると降順となります。
例：検索結果の順序として ORDER BY FREE_ITEM1 DESC NULLS LAST の形で指定したい場合、以下の配列形式のJSONを指定します。
[
{
"column":"FREE_ITEM1",
"nulls_last":true,
"sort_desc":true
}
]
例：検索結果の順序として ORDER BY FREE_ITEM1 DESC, FREE_ITEM2 DESC の形で指定したい場合、以下の配列形式のJSONを指定します。
[
{
"column":"FREE_ITEM1",
"nulls_last":false,
"sort_desc":true
},
{
"column":"FREE_ITEM2",
"nulls_last":false,
"sort_desc":true
}
]
免責事項
免責事項については こちら をご参照ください。
