クロスオーバーサーチ Webサービス(商品検索API)とは
クロスオーバーサーチ Webサービスは、リンクシェア参加企業がデータベースに登録した商品情報を検索・出力することができるWeb サービスAPI です。 クロスオーバーサーチ Webサービスを利用すると、リンクシェアに参加する複数企業を横断して商品情報をXML 形式で取得することができます。 クロスオーバーサーチ WebサービスはREST(REpresentational State Transfer)インターフェースに対応しています。

| パラメータ | 必須 | フォーマット | 説明 |
|---|---|---|---|
| token | ○ | 半角英数記号 | クロスオーバーサーチ Webサービスを利用する際の認証情報です。この情報によりサービス利用が可能なアフィリエイトであることを識別します。トークンは、最長64 バイトの暗号化された文字列で、アフィリエイト管理画面から取得します。 |
| keyword | ○ | 全半角 (UTF-8 で URL エンコード) |
検索時の文字列で、複数の文字列を指定することが可能です。その際はキーワードはダブルクォーテーションで括り、キーワードの間を半角スペースで区切ります。 すべてのキーワードを含むデータが欲しい場合に利用 (利用頂けない文字 , & = ? {} \ () [] - ; ~ | $ ! > * %) |
| exact | |||
| one | |||
| none | 全半角 (UTF-8 で URL エンコード) |
検索時の除外キーワードを指定します。複数の文字列を指定することが可能です。その際、キーワードはダブルクォーテーションで括り、キーワードの間を半角スペースで区切ります。 | |
| mid | 半角数字 | 参加企業指定 一度に複数のmid を指定することはできません。またアフィリエイト提携をしていない参加企業、商品情報を提供していない参加企業、無効なID を指定した場合、エラーになります |
|
| cat | 全半角 (UTF-8 で URL エンコード) |
主カテゴリを指定する場合にセットします。カテゴリは参加企業毎に異なります。 リンクシェア統一カテゴリ対応参加企業の場合は、横断的にカテゴリ指定が有効です。 |
|
| max | 半角数字 (0~100) |
結果取得件数 デフォルトで20 件まで受信しますが、このオプションを指定することで1回の検索でデフォルト以外の件数で結果を受信できるようになります。(0~100 を指定出来ます)max=0 を指定した場合、検索実行した際の総件数のみ取得します。 |
|
| pagenumber | 半角数字 | 検索結果のヒット件数が結果取得件数を超えた為、最初に取得した件数を超えた結果を取得するような場合に指定します。 未指定の場合(デフォルト)1となります。 |
|
| sort | retailprice/productname/ categoryname/mid |
検索結果を以下のフィールドで昇順および降順にソートする際に利用します。 このパラメータは複数指定することができます。その際は先に指定されたフィールドから順にソートが行われます。 参考価格:「retailprice」 商品名:「productname」 主カテゴリ名:「categoryname」 参加企業ID:「mid」 |
|
| sorttype | asc/dsc | sort パラメータとセットで利用します。昇順ソートの場合はasc、降順ソートの場合はdscを指定します。 このパラメータはsort パラメータを指定した場合必須です。 |
※文字コードはUTF8です。
| XMLタグ | データ | 例 |
|---|---|---|
| <TotalMatches> | 検索キーワードにヒットした総数です。例外として検索結果が5000 件を超える場合、-1 がセットされエラー時は、0がセットされます。 | 146 |
| <TotalPages> | 総ヒット数をmax で指定した件数で割った数。全データにアクセスする際の総ページ数。検索エラー時およびmax で0 を指定した場合は、0がセットされます。 | 8 |
| <PageNumber> | 取得したデータのページ番号。検索エラー時はおよびmax で0を指定した場合は、0がセットされます。 | 2 |
| <mid> | 参加企業の識別ID。個別に参加企業を検索する場合はこのIDを指定します。 | 2325 |
| <merchantname> | 参加企業名 | 町の電気屋さん |
| <linkid> | リンクを管理するためのリンクシェア内部の管理番号。 | 1000012 |
| <createdon> | リンク作成日 | 2009-06-01/20:04:17 |
| <sku> | 商品コード等 | JR-E-12324 |
| <productname> | 商品名 | Tony Blu-Ray Disc プレイヤー |
| <category> <primary> |
商品の主カテゴリ | AV機器 |
| <category> <secondary> |
商品のサブカテゴリ | AV Player |
| <price> | 参考価格 | 59800 |
| <upccode> | JAN コード | 4901340995017 |
| <description> <short> |
商品概要 | 高精細な映像をお楽しみ頂ける Tony Blu-Ray Disc プレイヤー |
| <description> <long> |
商品の詳細説明 | Tony Blu-Ray Disc プレイヤーは、既存のDVD だけでなく次世代映像メディアのBluRay の高品質な映像を楽しめます。HDMI のインターフェースに対応しておりケーブルが同梱されています。 |
| <keywords> | 商品を表すキーワード | DVD~~BluRay~~TONY |
| <linkurl> | リンクのURL | http://click.linksynergy.com/fs-bin/click?id=wYeATVOgEnE&offerid=80126.2&type=15&subid=0&lsnurltype=1 |
| <imageurl> | 商品画像のURL | http://www.lsjapan-store.jp/img/product/bluray01.gif |
<?xml version="1.0" ?>
<result>
<TotalMatches>146</TotalMatches>
<TotalPages>8</TotalPages>
<PageNumber>2</PageNumber>
<item>
<mid>2325</mid>
<merchantname>町の電気屋さん</merchantname>
<linkid>1000012</linkid>
<createdon>2009-06-01/20:04:17</createdon>
<sku>JR-E-12324</sku>
<productname>Tony Blu-Ray Disc プレイヤー</productname>
<category>
<primary>AV機器</primary>
<secondary>AV Player</secondary>
</category>
<price currency="JPY">59800</price>
<upccode>4901340995017</upccode>
<description>
<short>高精細な映像をお楽しみ頂ける Tony Blu-Ray Disc プレイヤー</short>
<long>Tony Blu-Ray Disc プレイヤーは、既存のDVD だけでなく次世代映像メディアのBluRay
の高品質な映像を楽しめます。HDMI のインターフェースに対応しておりケーブルが同梱されています。
</long>
</description>
<keywords>DVD~~BluRay~~TONY</keywords>
<linkurl>http://click.linksynergy.com/fs-bin/click?id=wYeATVOgEnE&offerid=80126.2&type=15&subid=0</linkurl>
<imageurl>http://www.lsjapan-store.jp/img/product/bluray01.gif</imgurl>
</item>
<item>
・・・・・・
</item>
</result>
APIの負荷となるアクセス数・リクエスト数の上限を公表しておりません。
通常利用を逸脱した負荷を検出した場合は、事前の通知なくサービスを停止する場合がありますので予めご了承ください。
PDFにて詳細な仕様をご確認いただけます。
下記からダウンロードください。