データアクセスAPI

ID APPDA

概要

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

ebisumartのリソース構造

ER図

バージョンコントロール

データアクセスAPIのリクエストのヘッダ「X-EBISU-API-VERSION」にバージョンの指定が必須です。
「X-EBISU-API-VERSION」に1を指定して頂きますようお願いします。
※現在はバージョン1しかありません。

機能分類

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

オプション別API

会員ランクオプション
アドレス帳オプション
商品シリアルオプション
ウィッシュリストオプション

共通パラメータ

検索条件

データアクセス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のように指定します。
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",
            }
        ],
    }
]

このページは参考になりましたか?

はい いいえ

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

ページトップへ戻る