厳選ホテル・旅館もポイント3倍

週末限定スマホ3倍

RaCoupon「買うクーポン」のAPI

RaCoupon「買うクーポン」(Shareee)では、開催地域一覧、地域毎最新クーポン詳細情報を提供するためのAPIを用意しております。


【更新履歴】

2011/06/08:フルエリアAPIの受信データに「販売中フラグ」を追加しました。

2011/06/03:クーポンデータ取得APIの受信データに「ジャンル」を追加しました。

2011/03/09:エリア一覧取得API、フルエリアAPIの受信データに「全国フラグ」を追加しました。

2011/02/29:クーポンデータ取得APIの受信データに「成立枚数」を追加しました。

2011/02/15:フルエリアAPIの提供を開始しました。

2011/02/04:formatにCSVを追加しました。

2011/02/01:APIの提供を開始致しました。


エリア一覧取得

RaCoupon「買うクーポン」(Shareee)で開催されている地域(子エリア)の一覧を取得できます。

※開催されている地域は、RaCoupon「買うクーポン」(Shareee)の地域情報に付いている地域です。

本APIはレスポンスを返すのに時間がかかることがあるため、結果をご利用側で5分程度キャッシュすることを推奨いたします。

Version.1、Version.2


  • 送信パラメータ
URL http://www.shareee.jp/api-v2/?type=area&format=[データフォーマット]
http://www.shareee.jp/api-v1/?type=area&format=[データフォーマット]

※「api-v1」「api-v2」どちらのURLでも機能に差異はありません。互換性の為に存在しております。
パラメータ
(GETで指定)
パラメータ 説明
type area 必須(固定)
format xml,json,php,csv 任意
指定がない場合はjson形式での取得となります

  • 受信データ

送信パラメータのformat形式で、開催されている地域一覧とクーポン番号が取得されます。

複数地域で同一クーポンが提供されている場合、同一のクーポン番号が地域毎に取得されます。

パラメータ 説明
code 地域のコード番号
name 地域の日本語名称
cid クーポン番号
zenkoku 全国フラグ。全国を対象とするクーポン(通販など)用のエリアの場合は1、そうでない場合は省略されます。

【参考】

json xml php csv
[{"code":"hokkaido","name":"\u5317\u6d77\u9053","cid":1162},{"code":"miyagi","name":"\u5bae\u57ce","cid":1160},{"code":"ibaraki","name":"\u8328\u57ce","cid":1151},{"code":"gunma","name":"\u7fa4\u99ac","cid":1197}] <response>
  <area>
    <code>hokkaido</code>
    <name>北海道</name>
    <cid>miyagi</cid>
  </area>


</response>
a:3:{i:0;a:3:{s:4:"code";s:8:"hokkaido";s:4:"name";s:9:"北海道";s:3:"cid";d:1162;}i:1;a:3:{s:4:"code";s:6:"miyagi";s:4:"name";s:6:"宮城";s:3:"cid";d:1160;}i:2;a:3:{s:4:"code";s:7:"ibaraki";s:4:"name";s:6:"茨城";s:3:"cid";d:1151;} "hokkaido","北海道",1162
"miyagi","宮城",1160
"ibaraki","茨城",1151
ルートノード<response>
親ノード<area>が付加されます
シリアライズされたデータが送信されます 1行ごとに改行されます。ダブルクオートは連続ダブルクオートでエスケープされます。

フルエリア一覧取得

RaCoupon「買うクーポン」(Shareee)で開催されている地域(インデックスエリア、子エリア)の一覧を取得できます。

※開催されている地域は、RaCoupon「買うクーポン」(Shareee)の地域情報に付いている地域です。

本APIはレスポンスを返すのに時間がかかることがあるため、結果をご利用側で5分程度キャッシュすることを推奨いたします。

Version.1、Version.2


  • 送信パラメータ
URL http://www.shareee.jp/api-v2/?type=fullarea&format=[データフォーマット]
http://www.shareee.jp/api-v1/?type=fullarea&format=[データフォーマット]

※「api-v1」「api-v2」どちらのURLでも機能に差異はありません。互換性の為に存在しております。
パラメータ
(GETで指定)
パラメータ 説明
type fullarea 必須(固定)
format xml,json,php,csv 任意
指定がない場合はjson形式での取得となります

  • 受信データ

送信パラメータのformat形式で、開催されている地域一覧とクーポン番号が取得されます。

複数地域で同一クーポンが提供されている場合、同一のクーポン番号が地域毎に取得されます。

その地域が、インデックスエリア(別のエリアをまとめているエリア)の場合、クーポン番号は送信されず、インデックスであるフラグが取得されます。

インデックスエリアにぶらさがっている子エリアの場合、親となるインデックスエリアのエリアコードが取得されます。

パラメータ 説明
code 地域のコード番号
name 地域の日本語名称
cid クーポン番号
indexonly インデックスエリアであるかのフラグ。インデックスエリアの場合「1」となる。インデックスエリアで無い場合は省略されます。
parentcode 親となるインデックスエリアのエリアコード(code)。インデックスエリアや、インデックスエリアが存在しない場合は省略されます。
onsale 販売中フラグ。cidで示されるクーポンが販売中かどうか。
zenkoku 全国フラグ。全国を対象とするクーポン(通販など)用のエリアの場合は1、そうでない場合は省略されます。

【参考】

json xml php csv
[{"code":"hokkaido","name":"\u5317\u6d77\u9053","cid":1162},{"code":"miyagi","name":"\u5bae\u57ce","cid":1160},{"code":"ibaraki","name":"\u8328\u57ce","cid":1151},{"code":"gunma","name":"\u7fa4\u99ac","cid":1197}] <response>
  <area>
    <code>hokkaido</code>
    <name>北海道</name>
    <cid>miyagi</cid>
  </area>


</response>
a:3:{i:0;a:3:{s:4:"code";s:8:"hokkaido";s:4:"name";s:9:"北海道";s:3:"cid";d:1162;}i:1;a:3:{s:4:"code";s:6:"miyagi";s:4:"name";s:6:"宮城";s:3:"cid";d:1160;}i:2;a:3:{s:4:"code";s:7:"ibaraki";s:4:"name";s:6:"茨城";s:3:"cid";d:1151;} "hokkaido","北海道",1162
"miyagi","宮城",1160
"ibaraki","茨城",1151
ルートノード<response>
親ノード<area>が付加されます
シリアライズされたデータが送信されます 1行ごとに改行されます。ダブルクオートは連続ダブルクオートでエスケープされます。

クーポンデータ取得

一覧から取得した地域のエリアコードとクーポン番号を指定して、クーポンの詳細を取得できます。

Version.1、Version.2


  • 送信パラメータ
URL http://www.shareee.jp/api-v2/?type=coupon&area_code=[エリアコード]&cid=[クーポン番号]&format=[データフォーマット]
http://www.shareee.jp/api-v1/?type=coupon&area_code=[エリアコード]&cid=[クーポン番号]&format=[データフォーマット]

※「api-v1」「api-v2」どちらのURLでも機能に差異はありません。互換性の為に存在しております。
パラメータ
(GETで指定)
パラメータ 説明
type coupon 必須(固定)
area_code [エリアコード] 任意
エリア一覧で取得したエリアコードを数値で指定。(本サイトではクーポン番号がサイト内一意な為、指定は任意となっております)
cid [クーポン番号] 必須
エリア一覧で取得したクーポン番号を数値で指定。
format xml,json,php,csv 任意
指定がない場合はjson形式での取得となります

  • 受信データ

送信パラメータのformat形式で、指定エリアのクーポン詳細が取得されます。

パラメータ 説明
title クーポンタイトル
sub_title クーポンサブタイトル
start 販売開始日時
expire 販売終了日時
coupon_start 利用開始日
coupon_expire 利用期限
area_name エリア名称
fixed_price 相当額(税込)
price 販売価格
buy_cnt 購入数
buy_success 成立枚数
buy_limit 購入枚数上限
buy_flg 販売フラグ
(YES:販売中,NO:販売終了)
buy_url サイトURL
twitter_url ツイート用URL
facebook_url シェア用URL
パラメータ 説明
use_option クーポン利用説明
note クーポン補足情報
recommend おすすめ文
ruby_says RaCoupon「買うクーポン」からのコメント
shop_name ショップ名
shop_zip 郵便番号
shop_address1 住所
shop_tel 電話番号
shop_near_station 最寄り駅
shop_open_hours 営業時間
shop_holiday 定休日等
shop_note ショップ補足情報
shop_map_url GoogleMapのURL
shop_img お店の画像(PC)
shop_img_mobile お店の画像(Mobile)
genre ジャンル(グルメ/ショッピング/レジャー・エンタメ/生活と暮らし)
  • 約600店舗で使える和民のクーポンへ
  • パステル特集
  • ラッキーおみくじ
  • 厳選ホテル・旅館もポイント3倍
特集/キャンペーン

お知らせ

買うクーポンの価格表記ポリシーを追加しました。
リンク先はこちら
  • 楽天カード新規入会で2,000円相当のポイントプレゼント
楽天グループのサービス
サービス一覧
お問い合わせ一覧
社会的責任[CSR]
関連サービス
おすすめ
【楽天カード】楽天スーパーポイントが2倍貯まるクレジットカード。年会費無料。