セール＆クーポンサーチ Webサービスとは

リンクシェアに参加している企業のセール、キャンペーン、クーポンといったアフィリエイトの実績に繋がりやすい情報を検索、取得できるWebサービスです。本サービスはREST（REpresentational State Transfer）インターフェースに対応しています。
※参加企業が提供する情報は、クーポンだけでなく割引やその他購入時の特典なども含みますが、この文書では、便宜上本サービスを介して提供されるリンクを「クーポン」と呼びます。

セール＆クーポンサーチ Webサービスを利用するためにはWebサービス用のトークンが必要になります。
トークンはリンクシェア管理画面から取得可能です。
トークンは変更することも可能であり、管理画面のトークン取得画面にある「トークンを更新」ボタンをクリックすることにより、新しいトークンを発行する事ができます。
その場合それまで使っていたトークンは利用できなくなりますので、ご注意ください。

• Webサービス用のトークンとは？
• トークンの取得方法について

以下URLに対して、パラメータを付加したRESTインターフェースでアクセスします。

http://couponfeed.linksynergy.com/coupon

※カテゴリ、プロモーションタイプマスタを取得する際にセットします。

このWebサービスで取得できるレスポンスは大きく2種あります。

1.カテゴリ、プロモーションタイプマスタ一覧を取得する

トークン：813cc94bbxecc6feb3e56dr637w015c3530894c01x3f488q6d62af7405bed1
promocat：1

上記の場合、以下のようなリクエストURLとなります。

http://couponfeed.linksynergy.com/coupon?
token=813cc94bbxecc6feb3e56dr637w015c3530894c01x3f488q6d62af7405bed1&promocat=1

XML データ・サンプル
取得したXML データの文字コードはUTF-8 です。

<?xml version="1.0" encoding="UTF-8"?>
<couponfeed>
<network id="11"><name>Japanese Network</name>
<categories>
<category id="100301">送料無料・送料割引</category>
<category id="100303">特典・プレゼント</category>
<category id="100306">新発売</category>
<category id="100304">初回購入限定</category>
<category id="100302">値引き・割引き</category>
<category id="100305">サプライズ</category>
<category id="100307">クーポン</category>
<category id="100308">その他</category>
</categories>
<promotiontypes>
<promotiontype id="9008">通期セール</promotiontype>
<promotiontype id="1002">花粉症</promotiontype>
<promotiontype id="3001">秋冬ファッション</promotiontype>
<promotiontype id="3002">秋のセール</promotiontype>
<promotiontype id="4008">福袋</promotiontype>
<promotiontype id="2001">父の日</promotiontype>
<promotiontype id="1008">母の日</promotiontype>
<promotiontype id="1006">春夏ファッション</promotiontype>
<promotiontype id="1004">春休み</promotiontype>
<promotiontype id="1001">春のセール</promotiontype>
<promotiontype id="1003">新生活</promotiontype>
<promotiontype id="3003">敬老の日</promotiontype>
<promotiontype id="2003">夏休み</promotiontype>
<promotiontype id="2005">夏のボーナス</promotiontype>
<promotiontype id="2004">夏のセール</promotiontype>
<promotiontype id="4005">冬休み</promotiontype>
<promotiontype id="4001">冬のボーナス</promotiontype>
<promotiontype id="4004">冬のセール</promotiontype>
<promotiontype id="9002">健康</promotiontype>
<promotiontype id="9006">レジャー</promotiontype>
<promotiontype id="3005">ボジョレーヌーヴォー</promotiontype>
<promotiontype id="1005">ホワイトデー</promotiontype>
<promotiontype id="4009">バレンタインデー</promotiontype>
<promotiontype id="3004">ハロウィーン</promotiontype>
<promotiontype id="9007">トラベル</promotiontype>
<promotiontype id="9003">ダイエット</promotiontype>
<promotiontype id="9005">スポーツ</promotiontype>
<promotiontype id="1007">ゴールデンウィーク</promotiontype>
<promotiontype id="9001">コスメ</promotiontype>
<promotiontype id="4003">クリスマス</promotiontype>
<promotiontype id="9004">アウトレット</promotiontype>
<promotiontype id="4002">お歳暮</promotiontype>
<promotiontype id="4006">お正月</promotiontype>
<promotiontype id="2002">お中元</promotiontype>
<promotiontype id="4007">おせち</promotiontype>
<promotiontype id="1">General Promotion</promotiontype>
<promotiontype id="9010">CD/DVD</promotiontype>
</promotiontypes>
</network>
</couponfeed>

2.セール、キャンペーン、クーポン情報を取得する

トークン：813cc94bbxecc6feb3e56dr637w015c3530894c01x3f488q6d62af7405bed1
mid：25089

上記の場合、以下のようなリクエストURLとなります。

http://couponfeed.linksynergy.com/coupon?
token=813cc94bbxecc6feb3e56dr637w015c3530894c01x3f488q6d62af7405bed1&mid=25089

XML データ・サンプル
取得したXML データの文字コードはUTF-8 です。

<?xml version="1.0" encoding="UTF-8"?>
<couponfeed>
<TotalMatches>5</TotalMatches>
<TotalPages>1</TotalPages>
<PageNumberRequested>1</PageNumberRequested>
<link type="BANNER">
<categories>
<category id="100302">値引き・割引き</category>
</categories>
<promotiontypes>
<promotiontype id="1003">新生活</promotiontype>
</promotiontypes>
<offerdescription>値引き・割引き（８０文字まで）</offerdescription>
<offerstartdate>2010-04-09</offerstartdate>
<offerenddate>2010-04-30</offerenddate>
<imageurl>http://www.linkshare.ne.jp/images/beginner_ttl_3.gif</imageurl>
<clickurl>http://click.linksynergy.com/fs-bin/click?id=GSFNlAS0O*w&amp;offerid=167830.228&amp;type=4&amp;subid=0
</clickurl>
<impressionpixel>http://ad.linksynergy.com/fs-bin/show?id=GSFNlAS0O*w&amp;bids=167830.228&amp;type=4&amp;subid=0</impressionpixel>
<advertiserid>25089</advertiserid><advertisername>テストECサイト</advertisername>
<network id="11">Japanese Network</network>
</link>
<link type="TEXT">
<categories>
<category id="100303">その他</category>
</categories>
<promotiontypes>
<promotiontype id="3001">秋冬ファッション</promotiontype>
</promotiontypes>
<offerdescription>その他（８０文字まで）</offerdescription>
<offerstartdate>2010-04-09</offerstartdate>
<offerenddate>2010-05-31</offerenddate>
<clickurl>http://click.linksynergy.com/fs-bin/click?id=GSFNlAS0O*w&amp;offerid=167830.128&amp;type=3&amp;subid=0</clickurl>
<impressionpixel>http://ad.linksynergy.com/fs-bin/show?id=GSFNlAS0O*w&amp;bids=167830.128&amp;type=3&amp;subid=0</impressionpixel>
<advertiserid>25089</advertiserid><advertisername>テストECサイト</advertisername>
<network id="11">Japanese Network</network>
</link>
</couponfeed>

リクエストは、一日当たり最大50リクエストまで（エラーの場合は含まず）です。なお、1日とはグリニッジ標準時(GMT)の午前0 時から24 時間(日本時間午前9:00 からの24 時間)を指します。

セール＆クーポンサーチ Webサービスには上記のとおり、1日50回のアクセス制限があります。
アプリ開発、検証時にアクセス制限による問題が発生する場合は、開発用のインターフェースをご利用ください。
開発用のインターフェースにはいくつかの制約があり、本番環境ではご利用いただけませんのでご注意ください。

全クーポンフィード取得インタフェース

http://www.bento-box.jp/apps/coupon/allcuponfeed_fordev.php

全クーポンフィード取得インタフェース

http://www.bento-box.jp/apps/coupon/allpromocat_fordev.php

制限事項

• 開発、検証時用のインタフェースであり、本番アプリ内に組み込む事は許可しません。
• 呼び出し制限はないが、著しく負荷をかけた場合、予告なく当該IPアドレスからのアクセスを停止する可能性があります。（ただし、その閾値は公開しない）
• トークン指定不要（トークンを指定しても返却されるリンクコードは自身のものにならなりません）
• 返却されるリンクコードはリンクシェアが管理するアカウントであり、自身のリンクコードは返却されません。（返却されるリンクコード経由で成果が発生した場合でも自身に報酬は付与されません）
• MID指定、カテゴリ、プロモーションタイプ指定などの検索性はありません。
• 返却されるXMLフォーマットはセール＆クーポンサーチ Webサービスで返却されるXML構造と同等です。

データファイルの詳細や、追加属性についてはPDFにて詳細な仕様をご確認いただけます。
下記からダウンロードください。

• リンク先ページ下部よりダウンロードをお願いします

このサンプルでは、一度取得したクーポンフィードを一定時間キャッシュしておくことで、
当Webサービスの1日の最大リクエスト制限を考慮しつつ、かつパフォーマンスの向上が図れるようにしています。
キャッシュ機構としてPEAR::Cache_Liteを、XMLパーサーとしてPEAR::XML_Serializerを活用しています。
尚、ご利用の環境によってはそのまま動作しないケースがあります。
ご了承ください。

require_once "Cache/Lite.php";
require_once "XML/Unserializer.php";

// Cache_Liteのオプション設定
$cacheOptions = array(
'cacheDir' => 'キャッシュ保存に使うディレクトリ',
'lifeTime' => キャッシュしておく時間,
);
$cacheLite = new Cache_Lite($cacheOptions);

// XMLパース時のオプション設定
$xmlOptions= array(
    'encoding' => 'UTF-8',
    'parseAttributes' => TRUE,
    'forceEnum' => array('link','promotiontypes','categories', 'category', 'promotiontype')
);
$xml = new XML_Unserializer($xmlOptions);

// キャッシュからデータ取得を試みる
$data = $cacheLite->get($token);
if($data) {
  // 有効なキャッシュがあった場合はそのデータを利用する
} else {
  $req = "セール＆クーポン Webサービス用リクエストURL組み立て";
  $data = file_get_contents($req);

  $xml->unserialize($data, false);
  $struct = $xml->getUnserializedData();
  if(array_key_exists('errorcode',$struct)) {
    // エラーを検出した場合はキャッシュ保存処理は行わない
  } else {
    // エラーがなかった場合のみキャッシュ保存を行う
    $cacheLite->save($data, $token);
  }
}