CASE.04 外部システムとの商品データの連携
概要
広告媒体を使用した販売促進を強化するために、ebisumartの商品データをリターゲティング広告サービスに渡したいというご要望があった際に利用されたAPIについての紹介になります。
利用するAPI
データアクセスAPI
カスタマイズ例
こちらの例では、商品情報を任意の条件でebisumartより取得し、
取得した情報をCSVファイル化した後、ebisumartを経由して外部サービスへ転送しています。
商品情報の取得に関して、こちらの例では複数の商品を対象として取得できる【/items】を利用しています。
また、CSVファイル等のファイルをebisumart上に格納するには【/files/{path}】が利用できます。
商品情報の取得
商品情報の取得は /items を利用することで実現出来ます。
取得カラムの指定はselect句を利用します。
例えば商品情報のITEM_CD,ITEM_NAME,TEIKAを抽出するには次のリクエストで実現できます。
- リクエスト
GET /items.json?select=ITEM_CD,ITEM_NAME,TEIKA- レスポンス
200 OK [ {"ITEM_CD": "item1", "ITEM_NAME": "商品1", "TEIKA": 1000}, {"ITEM_CD": "item2", "ITEM_NAME": "商品2", "TEIKA": 2000}, {"ITEM_CD": "item3", "ITEM_NAME": "商品3", "TEIKA": 4000} ]
また、検索条件はquery句を用いて、リクエストパラメータにJSON形式で条件を追記することで指定することが出来ます。
例えば先ほどのリクエストに、最終更新日が2022/01/01以降の商品という条件を加える場合、次のようなリクエストになります。
GET /items.json?select=ITEM_CD,ITEM_NAME,TEIKA&query=%5B%7B%22column%22%3A%22UPDATE_DATE%22%2C%22operator%22%3A%22more_than_equals%22%2C%22to_char_format%22%3A%22YYYY%2FMM%2FDD%22%2C%22value%22%3A%222022%2F10%2F13%22%7D%5Dその他、query句に指定できる検索条件の詳細については、 データアクセスAPIページの共通パラメータ をご参照ください。
ファイルの格納
ファイルの格納については /files/{path} を利用することで実現出来ます。
前項にて取得した商品情報をCSV形式に加工した後、「items.csv」というファイル名で
「新規ファイル」として格納したい場合、下記のようなリクエストを実行してください。
POST /files/WEB%2dINF/upload/items%2ecsv.json?operation=create
[body内容例]
ITEM_CD, ITEM_NAME, TEIKA
item1,商品1,1000
item2,商品2,2000
item3,商品3,4000リクエストの「items%2ecsv」部分は作成したいファイル名になります。
また、リクエストパラメータにはoperation句を設定して、どのような操作をするかを指定する必要があります。
設定できる値に関する詳細は /files/{path}ページ にてご確認をお願い致します。
