データアクセスAPI

トップ＞開発をする方向け＞データアクセスAPI

データアクセスAPI

概要

データアクセスAPIはREST形式のAPIです。データアクセスAPIを使用することにより、ebisumartのリソース（商品情報や会員情報など）にアクセスすることができます。APIの詳細につきましては、機能分類の各リソースのページをご確認ください。
※データアクセスAPIでは、OAuthを用いて認証を行います。具体的な手順については、Appsのインストールをご覧ください。

また、このAPIを利用した実例について、 Apps活用事例 にて掲載しておりますので、こちらの内容と併せてご覧いただけますと幸いです。

ebisumartのリソース構造

ER図

バージョンコントロール

データアクセス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"という文字列として扱われます。

機能分類

提供する機能は下記に分類されます。詳細については下記のリンク先をご覧ください。

共通パラメータ

検索条件

データアクセスAPIのパラメータとして検索条件を指定可能な場合、以下の定義にしたがい検索条件を指定することができます。

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を指定します。

[
    {
        "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"
            }
        ]
    }
]

免責事項

免責事項については こちら をご参照ください。

データアクセスAPI | サポートサイト

開発者向けサポート