akizuki-api

beta version

What is this

秋月電子通商で取り扱っている商品などの情報をJSON形式で取得することができるWeb APIです。

通販Webページからデータを取得し、商品情報を一定期間キャッシュしています。
キャッシュに情報が存在する場合はこれを返すことで高速かつ通販サイトへ負荷の掛からない処理を実現しています。


注意事項

akizuki-apiはベータ版です。
予告なく機能の追加変更削除、提供の停止などが発生する可能性があります。
ご要望やバグ、セキュリティ上の問題などを発見された方は @9SQ までご連絡ください。


最重要注意事項

akizuki-apiは株式会社 秋月電子通商とは一切関係ありません。本WebAPIに関するお問い合わせを絶対にしないでください。


その他

セッション切れで消えてしまう買い物かごと仲良くなるためのサービスも公開中です。
AKiCart
使い方: Let's try using AkiCart!! (Speaker Deck)

API Reference

GET component/:id.json

通販コードで指定した1件の商品情報をJSONで取得する


Resource URL

https://akizuki-api.appspot.com/component/:id.json


Parameters

Name Required Description Example
:id required 通販コードを指定。通販コードは必ず ^[MKPBRSICT]-[0-9]{5}$ でなければならない。 M-13289

Example Request

GET https://akizuki-api.appspot.com/component/M-13289.json


Example Response

{
  "id": "M-13289",
  "status": {
    "code": 200,
    "description": "OK."
  },
  "name": "Wi−Fiモジュール ESP−WROOM−02D",
  "part_number": "ESP-WROOM-02D",
  "release_date": "2018/04/24",
  "manufacturer": "Espressif Systems (Shanghai) Pte. Ltd.",
  "price": {
    "value": 540,
    "currency": "JPY"
  },
  "stores": [
    {
      "name": "秋葉原店",
      "place": "1F 28 【外】台車売場天面",
      "count": 64
    },
    {
      "name": "八潮店",
      "place": "売場0101",
      "count": 20
    }
  ],
  "last_update": "2018-05-27T00:00:00+09:00"
}

last_updateはakizuki-api側で最後にキャッシュした日時を表します。


POST component/list.json

通販コードで指定した複数件の商品情報をJSONで取得する


Resource URL

https://akizuki-api.appspot.com/component/list.json


Parameters

Name Required Description Example
ids required 通販コードのリストを指定。通販コードは必ず ^[MKPBRSICT]-[0-9]{5}$ でなければならない。 {"ids":["M-13289", "C-00167"]}

Example Request

POST https://akizuki-api.appspot.com/component/list.json

{
  "ids": ["M-13289", "C-00167", "C-05779", "P-03688", "P-03229"]
}

Example Response

{
  "components": [
    {
      "id": "M-13289",
      "name": "Wi−Fiモジュール ESP−WROOM−02D",
      "part_number": "ESP-WROOM-02D",
      "release_date": "2018/04/24",
      "manufacturer": "Espressif Systems (Shanghai) Pte. Ltd.",
      "price": {
        "currency": "JPY",
        "value": 540
      },
      "stores": [
        {
          "count": 18,
          "place": "売場0002 フック陳列",
          "name": "八潮店"
        },
        {
          "count": 27,
          "place": "1F売場 07",
          "name": "秋葉原店"
        }
      ],
      "last_update": "2018-05-27T00:00:00+09:00"
    },
    ...
    {
      "id": "P-03229",
      "name": "片面ガラスコンポジット・ユニバーサル基板 Cタイプ めっき仕上げ (72x47mm) 日本製",
      "part_number": null,
      "release_date": "2009/12/03",
      "manufacturer": "株式会社矢島製作所",
      "price": {
        "currency": "JPY",
        "value": 60
      },
      "stores": [
        {
          "count": 87,
          "place": "売場0107 ②",
          "name": "八潮店"
        },
        {
          "count": 332,
          "place": "1F 16 売場 3段目",
          "name": "秋葉原店"
        }
      ],
      "last_update": "2018-05-27T00:00:00+09:00"
    }
  ]
}

last_updateはakizuki-api側で最後にキャッシュした日時を表します。

同時に大量の通販コードを指定した場合、リクエストがタイムアウトする場合があります。1回のリクエストが最大10件程度ずつになるよう分割することをお勧めします。

以下、機能追加中...