【garitto】商品専門検索エンジン



TOPWebサービスAPI仕様

garittoとは


API仕様

リクエストURL

APIリクエスト送信URL

http://garitto.com/api.php?action=api_ver1_rest
&[developerId]=[value]&[type]=[value]&[parameter]=[value]…

※実際は改行しないで下さい。


[developerId]に登録ID、[type]に利用APIフラグを設定します。必須項目コードをする必要があり。

以降、「&」にて入力パラメーターを設定する。「keywordTag」、「keyword」,「sort0,sort1,sort2」値については、UTF-8にてURLエンコードする必要があります。

具体例

検索キーワード=スカート

並び順=人気順

上記の条件の場合、APIリクエストURLは以下のようになります。

APIリクエスト送信URL

http://garitto.com/api.php?action=api_ver1_rest&developerId=[DEVELOPER_ID]
&type=ProductSearch&keyword=%E3%82%B9%E3%82%AB%E3%83%BC%E3
%83%88&sort0=rankingDesc

※実際は改行しないで下さい。

パラメーターの説明

パラメーター 内容
developerId=[DEVELOPER_ID]
  • デベロッパーID。
    APIユーザー登録で取得したデベロッパーIDを設定
type=ProductSearch
  • 提供APIフラグ「ProductSearch」を設定
keyword=%E3%82%B9%E3%82%
AB%E3%83%BC%E3%83%88
  • 検索キーワード「スカート」UTF-8のURLエンコードされた値を設定
sort0=rankingDesc
  • 並び替えの人気順フラグ「rankingDesc」を設定

入力パラメーター

区分 ID 項目 parameter 必須 デフォルト 備考
共通 1 登録ID developerId String ---
  • API利用登録者ID
  • 24桁
  • 英数字
2 操作API type String ---
  • 利用するAPI処理名:
    ProductSearch
入力 1 検索キーワード Keyword String
※1
---
  • ※1のいずれかを指定する必要あり
  • 検索キーワード(文字列)
  • 空白区切りでAND検索
  • ☆UTF-8のURLエンコード必要があり
2 検索キーワード
タグ
keywordTag String
※1
---
  • ※1のいずれかを指定する必要あり
  • 検索キーワードタグ(文字列)
3 カテゴリID categoryId int4
※1
---
  • ※1のいずれかを指定する必要あり
  • garittoカテゴリIDの指定
4 サブカテゴリID categorySubId int4
※1
---
  • ※1のいずれかを指定する必要あり
  • garittoカテゴリIDに基づいているサブID
6 ソート sort0
sort1
sort2
String - rankingDesc
  • rankingDesc:
    人気順(降順)
  • rankingAsc:
    人気順(昇順)
  • priceDesc:
    価格順(降順)
  • priceAsc:
    価格(昇順)
  • registTimeDesc:
    登録日順(降順)
  • registTimeAsc:
    登録順(昇順)
  • ☆UTF-8URLエンコードの必要があり
  • 上記の3項目までソート組み合わせが可能です
7 最小価格 minPrice int8 - 指定なし
  • 0より大きい整数
8 最大価格 maxPrice int8 - 指定なし
  • 0より大きい整数。「最小価格」より大きい必要あり
9 1ページあたりの
取得件数
pageLimit int4 - 30
  • 1ページに表示するデータ件数。1〜30
10 取得ページ番号 page int4 - 1
  • 表示するページ番号。
    1〜100

出力パラメーター

区分 ID 分類 項目 parameter 備考
共通
出力
1   - developerId
  • Valueには登録ユーザーdeveloperId
- type
  • Valueにはユーザーの指定した操作API
- version
  • Valueにはユーザーの指定したバージョン情報
- keyword
  • ユーザーの指定した入力parameter
- categoryId
  • カテゴリID
- categorySubId
  • カテゴリサブID
- sort
  • 並び替えタイプ
- maxPrice
  • 指定最高価格
- minPrice
  • 指定最低価格
- pageLimit
  • ページ内に表示する件数
- page
  • 指定したページ番号
2 Status - Status
  • 処理結果
3 StatusMsg - StatusMsg
  • 処理結果に応じたメッセージを表示する
出力 1 全体情報 検索総数 count
  • 検索総数
2 ページ番号 page
  • 現在のページ
3 ページ内
商品開始番号
start
  • データ取得開始位置
4 ページ内
商品終了番号
end
  • データ取得終了位置
5 ページ内
検索数
hits
  • データ取得件数
7 ページ総数 pageCount
  • ページ総数
8 タグ情報   productHitTagStr
  • 検索結果商品についているタグ一覧
8 tag
  • 検索結果商品についているタグ
9 cnt
  • 各タグの数
10 商品情報 商品名 productId
  • 商品ID
11 商品名称 productName
  • 商品名称
12 商品説明 productDescprition
  • 商品説明
13 商品価格 productPrice
  • 商品価格
14 商品タグ productTag
  • 商品タグ
15 商品URL productUrl
  • http://garitto.com/product/index/
    [productId]
    ※実際は改行しないで下さい。
16 商品画像
サムネイルURL
thImageUrl
  • 80x80
  • http://garitto.com/data/product/
    [dirname]/〜.png
    ※実際は改行しないで下さい。
17 ブックマーク
ユーザー人数
productMarkUser
  • ブックマークユーザー数
18 商品レビュー数 productReviewCnt
  • レビュー数
19 商品あしあと数 productFootprintCnt
  • 商品あしあと数
20 商品画像
通常URL
imageUrl
  • 250x250
  • http://xxx.ocnk.net/〜
    または、独自ドメイン
21 店舗情報 店ID shopId
  • ショップID
22 店名 shopName
  • ショップ名称
23 店説明 shopDiscprition
  • ショップ説明
24 店URL shopUrl
  • http://garitto.com/myshop/index/
    [shopId]
    ※実際は改行しないで下さい。

エラー

Statusでの表示 内容
NotFound
  • 検索結果が存在しない
UserError
  • ユーザー必須項目設定エラー