アフィリエイトシステム

CyberShop21 Web APIリファレンス

β版 version 1.0-20100216


■カテゴリマスタAPI

リクエストURL

http://www.cy21.jp/webapi/

リクエストクエリ

パラメータ 項目名 説明 必須
request リクエストタイプ カテゴリリストを要求します。 固定:category
type タイプ レスポンスデータの種類指定をします。 - 0:全カテゴリ(デフォルト)
1:トップカテゴリのみ
format レスポンス形式 レスポンス形式を指定します。 - json(デフォルト) ※1
※1 json以外の形式は今後対応の予定です。

サンプルクエリ

http://www.cy21.jp/webapi/?request=category&type=1


レスポンスフィールド

フィールド 説明
status レスポンスステータス OK
エラー時はOK以外の文字列が返却される
info レスポンス情報 (配列)
┗ api_version APIバージョン 1.0
┗ results_returned 結果データ数 39
┗ create_time データ作成(キャッシュ)日時 2010-02-15 15:42:10
┗ type リクエストされたタイプ情報 0
data データ (配列)
┗ key(id) キー (配列)
 ┗ id カテゴリID 1
 ┗ name カテゴリ名 ダイエット
 ┗ full_name フルカテゴリ名 ダイエット/サプリ
 ┗ parent 親カテゴリID 1
 ┗ depth 階層 2
 ┗ item 登録アイテム数 5

サンプルレスポンス

{ "status" : "OK",
"info" : { "api_version" : "1.0",
"results_returned" : 8,
"create_time" : "2010-02-15 15:43:20",
"type" : 1
},
"data" : { "1" : { "id" : 1,
"name" : "\uff80\uff9e\uff72\uff74\uff6f\uff84",
"full_name" : "\uff80\uff9e\uff72\uff74\uff6f\uff84",
"parent" : 0,
"depth" : 1,
"item" : 4
}
}
}

■商品情報API

リクエストURL

http://www.cy21.jp/webapi/

リクエストクエリ

パラメータ 項目名 説明 必須
request リクエストタイプ 商品情報を要求します。 固定:item
category カテゴリID 取得するカテゴリIDを指定します。 例:1
order ソート順 結果の並び順を指定します。 - 0:商品ID降順(デフォルト)
1:商品ID昇順
2:報酬金額降順
3:報酬金額昇順
start 開始位置 結果データを何件目から返却するかを指定します。 - 1(デフォルト)
limit 取得データ件数 最大データ件数を指定します。最大:100。 - 100(デフォルト)
format レスポンス形式 レスポンス形式を指定します。 - json(デフォルト) ※1
※1 json以外の形式は今後対応の予定です。

サンプルクエリ

http://www.cy21.jp/webapi/?request=item&category=2&order=1


レスポンスフィールド

フィールド 説明
status レスポンスステータス OK
エラー時はOK以外の文字列が返却される
info レスポンス情報 (配列)
┗ api_version APIバージョン 1.0
┗ total_target 結果データ総数 100
┗ results_returned 返却データ件数 100
┗ create_time データ作成(キャッシュ)日時 2010-02-15 15:42:10
┗ category カテゴリーID 1
┗ start 開始位置 0
┗ limit リクエストデータ件数 0
┗ order ソート順 0
data データ (配列)
┗ key(id) キー (配列)
 ┗ item_id 商品ID 1
 ┗ product_name 商品名 プレミアムコラーゲンドリンク
 ┗ category_id カテゴリID 10
 ┗ new 新着フラグ 1
 ┗ catchcopy キャッチコピー(未設定商品あり) [省略]
 ┗ explanation 商品詳細 [省略]
 ┗ fixed_price 一般価格 例:10000
または オープンプライス
 ┗ unit_price 商品価格(税抜) 1000
 ┗ price_tax_in 商品価格(税込) 1050
 ┗ t_image 商品画像サムネイル http://cy21.jp/t_8805_1.item.jpg
 ┗ image 商品画像 http://cy21.jp/m_8805_1.item.jpg
 ┗ url 商品ページURL http://cy21.jp/8805.item.html
 ┗ aff_url アフィリエイト用商品ページURL ※2 http://cy21.jp/item_8805_AFFILIATERID.afapi.html
 ┗ affiliate_remuneration アフィリエイト報酬額 ※1
 ┗ user_review ユーザーレビュー (配列) 0~20件(最大)
  ┗ review_key(number) キー (配列)
   ┗ nick_name ニックネーム にゃんこ先生
   ┗ comment コメント [省略]
   ┗ rating 評価(0~5) 5
※1 コンテンツとして利用する場合は商品価格と間違わないよう配慮をお願いします。
※2 文字列 "AFFILIATERID" をご自身のアフィリエイターIDと置き換えてご利用ください。

サンプルレスポンス

{
"status" : OK,
"info" : { "api_version" : "1.0",
"total_target" : 1,
"results_returned" : 1,
"start" : 1,
"limit" : 100,
"order" : 0,
"category" : 10,
"create_time" : "2010/2/16 13:11"
},
data : { 8805 : { "name" : "ITEM_NAME",
"item_id" : 8805,
"category_id" : 9,
"new" : 0,
"fixed_price" : 8400,
"unit_price" : 2800,
"price_tax_in" : 2940,
"t_image" : "http:\/\/cy21.jp\/t_8805_1.item.jpg",
"image" : "http:\/\/cy21.jp\/m_8805_1.item.jpg",
"url" : "http:\/\/cy21.jp\/8805.item.html",
"aff_url" : "http:\/\/cy21.jp\/item_8805_AFFILIATERID.afapi.html",
"catchcopy" : "CATCHCOPY",
"explanation" : "EXPLANATION",
"affiliate_remuneration" : "1000",
"user_review" : [{ "nick_name" : "NICKNAME",
"comment" : "COMMENT",
"rating" : 5
}]
}
}
}

■サンプルコード(PHP)

カテゴリマスタ取得PHP

<?php

    $api_url = "http://cy21.jp/webapi/?request=category";

    $json_data = file_get_contents($api_url);

    $array = json_decode($json_data,true);

    var_dump($array);

?>

商品情報取得PHP

<?php

    $api_url = "http://cy21.jp/webapi/?request=item&category=10";

    $json_data = file_get_contents($api_url);

    $array = json_decode($json_data,true);

    var_dump($array);

?>

■クレジット表示義務について

CyberShop21 Webサービス(β版)の提供するAPIを利用するすべてのサイトやアプリケーションには、
必ずクレジットを表示する必要があります。

掲載するクレジットは、以下より選択してください。

タイプ 表示形式 クレジット
タイプA 画像形式 135px x 17px CyberShop21
タイプB 画像形式 88px x 35px CyberShop21
タイプC テキスト形式 Powered by CyberShop21 Webサービス(β版)

クレジットのHTMLソース

・タイプA
<a href="http://cy21.jp/"><img src="http://www.cy21.jp/webapi/CyberShop21-135x17.gif" border="0" alt="CyberShop21">

・タイプB
<a href="http://cy21.jp/"><img src="http://www.cy21.jp/webapi/CyberShop21-88x35.gif" border="0" alt="CyberShop21">

・タイプC
Powered by <a href="http://cy21.jp/">CyberShop21 Webサービス(β版)</a>


  サイトトップ / お問い合わせ / 利用規約 / Web API / 会社概要 / SHOPPING.JPアフィリエイトサービス
Copyright (c)2009-2010 I-FREEK INC. All Rights Reserved.