2007年06月29日
■WebAPI第一弾のCategory APIを公開します
皆さん、お待たせしました。
TSUKUMO WebAPI 第一弾のCategory APIを公開します。
ツクモが管理する商品の情報を一覧で取得するためのAPIです。
詳細は下記をご確認ください。
Category API
TSUKUMO ネットショップのカテゴリツリーを元にした商品の情報を一覧で取得します。
リクエストURL
http://shop.tsukumo.co.jp/dir.(json|yaml)
もしくは
http://shop.tsukumo.co.jp/dir/{カテゴリID}.(json|yaml)
カテゴリIDを付けない形式の場合は、単純の特大カテゴリの情報のみを返します。
カテゴリIDが4桁未満のカテゴリの場合は、商品一覧を返しません。
リクエストURLパラメータ
| パラメータ | 値 | 備考 |
| sort | SCALAR | 商品ソートするためのパラメータです。price(価格)のみが指定出来ます。指定しない場合の順番は未定義です |
| order | SCALAR | オーダーの順番を指定するパラメータです。asc(昇順)、desc(降順) |
| num | SCALAR | 一覧の表示件数を指定するパラメータです。10、20、50の値で指定します |
| page | SCALAR | ページ数 |
リクエストURLサンプル
http://shop.tsukumo.co.jp/dir.yaml
http://shop.tsukumo.co.jp/dir/10.json
http://shop.tsukumo.co.jp/dir/1005.yaml
http://shop.tsukumo.co.jp/dir/2005.json?order=desc&sort=price&page=2
レスポンスフォーマット
JSONとYAMLに対応しています。
ただしYAMLは実験的サポートです。
レスポンスフィールド
以下の3つのフィールドを親キーとするハッシュデータを返します。
| パラメータ | 型 | 備考 |
| categories | ARRAY | リクエストされたカテゴリ以下に配置しているカテゴリのデータ。配列の中の詳細はCategoriesを参照 |
| items | ARRAY | リクエストされたカテゴリ以下に登録されている商品データ。配列の中の詳細はItemsを参照 |
| pager | HASH | リクエストに対するページング情報。PerlのCPANライブラリのData::Pagesetにそのまま渡せる値を出力しています。ハッシュの中の詳細はPagerを参照 |
Categories
| パラメータ | 型 | 備考 |
| id | SCALAR | カテゴリID |
| name | SCALAR | カテゴリ名 |
| items | SCALAR | カテゴリに登録されている商品点数 |
Items
| パラメータ | 型 | 備考 |
| jancode | SCALAR | 商品コード |
| name | SCALAR | 商品名 |
| summary | SCALAR | 商品概要 |
| categories | ARRAY | 商品が登録されているカテゴリの一覧。配列の中の詳細はItemsCategoriesを参照 |
| maker | ARRAY | 商品のメーカー情報。ハッシュの中の詳細はItemsMakerを参照 |
| prices | ARRAY | 商品の価格一覧。配列の中の詳細はItemsPricesを参照 |
| metafiles | ARRAY | 商品に紐付けられたメタデータの一覧。現在は主に画像データのURLのみです |
| specs | ARRAY | 商品のスペック一覧。配列の中の詳細はItemsSpecsを参照 |
Items - Categories
| パラメータ | 型 | 備考 |
| id | SCALAR | カテゴリID |
| name | SCALAR | カテゴリ名 |
Items - Maker
| パラメータ | 型 | 備考 |
| name | SCALAR | メーカー名 |
Items - Prices
| パラメータ | 型 | 備考 |
| price | SCALAR | 税込み価格 |
| point | SCALAR | ポイント |
| type | SCALAR | 価格の種別 (現在はdefaultのみ) |
Items - Specs
| パラメータ | 型 | 備考 |
| name | SCALAR | スペック名 |
| value | SCALAR | スペックの値 |
Pager
| パラメータ | 型 | 備考 |
| total_entries | SCALAR | 商品数 |
| current_page | SCALAR | 現在指定されているページ番号 |
| entries_per_page | SCALAR | 1ページあたりに表示する商品数 |
| last_page | SCALAR | 最後のページ番号 |
免責事項
現在は実験的に公開をしている為、予告無く仕様が変更になったりサービス提供を中止する事がある事を、予めご了承ください。
短時間で大量のリクエストを行った場合は、アクセス制限を行う場合があります。
トラックバック
このエントリーのトラックバックURL:
当サイトでは、記事に対してトラックバックすることが可能です。
当サイトに対してトラックバックする方は、以下の点をあらかじめご了承の上ご利用ください。
- 1. 記事の引用
- 記事を引用する場合は、必ず引用元にリンクを貼ってください。
- 2. 禁止行為
- 以下のトラックバックは禁止いたします。
- 宣伝目的のトラックバック
- 記事と無関係な内容を掲載しているサイトからのトラックバック
- 著作権など知的財産権を侵害しているサイトからのトラックバック
- 公序良俗に反しているWebからのトラックバック
- 第三者のプライバシーを侵害しているサイトからのトラックバック
- 第三者の名誉を毀損しているサイトからのトラックバック
- その他当サイトに相応しくないと当サイト運営者が判断するサイトからのトラックバック
- 3. 免責
- 上記禁止事項に当てはまる行為、または当サイト運営者が不適当と判断した行為については、当事者への事前の通知なしに該当するリンク・表示を削除することがあります。