# Cleanfeedについて

Cleanfeedは自動フィードがクロールにより取得・整形した寸法データをJSON形式で出力するデータサービスです。

Cleanfeed APIから返却されるJSONデータを定期的にオンラインショップのDBに格納することで、寸法データを利用した機能を独自開発することができます。例えば寸法データを軸とした商品検索、レコメンドエンジンのマッチング精度向上、リスティング広告のROI改善、サイズ表の自動生成など、幅広い応用が可能です。

# API Key

Cleanfeedを利用開始するには、API Keyが必要となります。取得するには japan@virtusize.com までご連絡ください。

# API エンドポイント

https://api.virtusize.com/typemapper/cleanfeed/ストア名?apiKey=APIKey&from=年-月-日&to=年-月-日&page=

# パラメータ

no パラメータ名
1 ストア名 対象となるストア名をで指定
例: demo_store
2 apiKey 対象となるストアAPI Keyで指定
例: 15cc36e1d7dad62b8e11722ce1a245cb6c5e6692
3 from, to 開始日および終了日をYYYY-MM-DD形式で指定
例: 2019-12-01
4 page ページの数字を指定(1から)、返却結果は最大 1000アイテム
例: 1

# サンプル API コール

# CURL

curl "https://api.virtusize.com/typemapper/cleanfeed/virtusize_demo_store?apiKey=15cc36e1d7dad62b8e11722ce1a245cb6c5e6692&from=2018-12-01&to=2018-12-05&page=1" 

# HTTPie

http GET 'https://api.virtusize.com/typemapper/cleanfeed/virtusize_demo_store?apiKey=15cc36e1d7dad62b8e11722ce1a245cb6c5e6692&from=2018-12-01&to=2018-12-05&page=1' 

# レスポンス例およびデータ型

# 200 OK

[
  {
    product_type": "tShirt",
    sizes": [
      {
        "measurements": {
          "shoulder": 39.0,
          "sleeve": 63.5,
          "bust": 53.0,
          "height": 63.0
        },
        "name": "L"
      },
      {
        "measurements": {
          "shoulder": 40.0,
          "sleeve": 64.0,
          "bust": 57.0,
          "height": 65.0
        },
        "name": "XL"
      },
      {
        "measurements": {
          "shoulder": 38.0,
          "sleeve": 63.0,
          "bust": 48.0,
          "height": 63.0
        },
        "name": "M"
      }
  },
  ...
]

# 0件結果のレスポンス

最大のページナンバーを超えたら、0件を返却。

[]

# サーバエラー

サーバに起因するエラーが発生すると、以下のエラーが返却されます。

{
  status: "500",
  error: "Internal Server Error"
}