ポンパレWebサービス: APIリファレンス

チケットAPI

リクエストURL

https://ws.ponpare.jp/ws/wsp0100/Wst0201Action.do

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIキー発行機能のリリースまでは、「sample」を使用。APIキー「sample」の有効期限は2011年2月22日AM5:59を予定しております。
large_area 大エリア 大エリアコードで検索(完全一致)します。
(1個まで指定可、2個以上指定すると2個目以降無視します)。*2。
*1
middle_area 中エリア 中エリアコードで検索(完全一致)します。
(3個まで指定可、4個以上指定すると4個目以降無視します)。*2。
※ 中エリアが存在した場合、大エリアは無視。
*1
small_area 小エリア 小エリアコードで検索(完全一致)します。
(5個まで指定可、6個以上指定すると6個目以降無視します)。*2。
※ 小エリアが存在した場合、大エリア、中エリアは無視。
*1
ticket_id チケットID ※ チケットIDが存在した場合、大エリア、中エリア、小エリアは無視。 *1
format レスポンス形式 レスポンスをXMLかJSONかJSONPかを指定します。

*1 「大エリア、中エリア、小エリアのいずれか1つ」か「チケットID」のどちらかは必須で設定。
*2 複数指定可能パラメータの指定方法
name=value1,value2,...

サンプルクエリ

https://ws.ponpare.jp/ws/wsp0100/Wst0201Action.do?key=sample&small_area=8,9

レスポンスフィールド

フィールド 説明
results -
number_of_results 該当件数
display_per_page レスポンス内表示件数
display_from レスポンス内表示開始番号
api_version APIバージョン
ticket -
id チケットID
catchcopy 商品キャッチコピー
leadcopy 商品リードコピー ※2013/1/21からは廃止予定 返却値は空となります。
name 商品名
usual_price 通常定価
price 販売価格
discount_rate 割引率
pic1 商品画像1のURL
pic2 商品画像2のURL
pic3 商品画像3のURL
pic4 商品画像4のURL
pic5 商品画像5のURL
thumbnail 商品画像サムネイルのURL
show_condition 提示条件
use_condition 利用条件
valid_from 有効期限(開始)
valid_until 有効期限(終了)
memo その他利用条件
description 商品説明分
comment ポンパレからのコメント
sales_from 販売開始日時
sales_until 販売終了日時
sales_limit 販売枚数上限
sales_min 取引成立に必要な最低販売枚数
ticket_detail_url チケット詳細URL
shop_name 店名
shop_tel 電話番号
shop_address 住所
shop_address_etc 住所(ビル名等)
shop_open_time 営業時間
shop_holidays 定休日
shop_access アクセス
shop_url URL
shop_y 緯度(世界測地系)
shop_x 経度(世界測地系)
max_per_purchase 1度の購入での最大購入枚数
small_area_cd 小エリアコード
genre ジャンル
sales_status 販売ステータス
0:販売中、1:取引成立中、2:SoldOut

サンプルレスポンス

販売ステータスAPI

リクエストURL

https://ws.ponpare.jp/ws/wsp0100/Wst0202Action.do

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIキー発行機能のリリースまでは、「sample」を使用。APIキー「sample」の有効期限は2011年2月22日AM5:59を予定しております。
ticket_id チケットID
format レスポンス形式 レスポンスをXMLかJSONかJSONPかを指定します。
JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事
により、javascript側コールバック関数の名前を指定できます。
初期値:xml。xml または json または jsonp。

サンプルクエリ

https://ws.ponpare.jp/ws/wsp0100/Wst0202Action.do?key=sample&ticket_id=1065

レスポンスフィールド

フィールド 説明
results -
number_of_results 該当件数
display_per_page レスポンス内表示件数
display_from レスポンス内表示開始番号
api_version APIバージョン
ticket -
id チケットID
time_left 残時間
hour 残時間(時)
minute 残時間(分)
secound 残時間(秒)
sales_limit 販売枚数上限
sales_min 取引成立に必要な最低販売枚数
sales_count 現在購入されている枚数
sales_left 残り販売枚数
sales_min_left 取引成立までの枚数
sales_status 販売ステータス
0:販売中、1:取引成立中、2:SoldOut

サンプルレスポンス

大エリアAPI

リクエストURL

https://ws.ponpare.jp/ws/wsp0100/Wst0101Action.do

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIキー発行機能のリリースまでは、「sample」を使用。APIキー「sample」の有効期限は2011年2月22日AM5:59を予定しております。
large_area 大エリア 大エリアコードで検索(完全一致)します。
(3個まで指定可、4個以上指定すると4個目以降無視します)。*2。
format レスポンス形式 レスポンスをXMLかJSONかJSONPかを指定します。
JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。
初期値:xml。xml または json または jsonp。

*2 複数指定可能パラメータの指定方法
または name=value1,value2,...

サンプルクエリ

https://ws.ponpare.jp/ws/wsp0100/Wst0101Action.do?key=sample

レスポンスフィールド

フィールド 説明
results -
number_of_results 該当件数
display_per_page レスポンス内表示件数
display_from レスポンス内表示開始番号
api_version APIバージョン
large_area 大エリア
code 大エリアコード
name 大エリア名

サンプルレスポンス

中エリアAPI

リクエストURL

https://ws.ponpare.jp/ws/wsp0100/Wst0102Action.do

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIキー発行機能のリリースまでは、「sample」を使用。APIキー「sample」の有効期限は2011年2月22日AM5:59を予定しております。
large_area 大エリア 大エリアコードで検索(完全一致)します。
(3個まで指定可、4個以上指定すると4個目以降無視します)。*2。
 
middle_area 中エリア 中エリアコードで検索(完全一致)します。
(5個まで指定可、6個以上指定すると6個目以降無視します)。*2。
※ 中エリアが存在した場合、大エリアは無視。
 
format レスポンス形式 レスポンスをXMLかJSONかJSONPかを指定します。
JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。
初期値:xml。xml または json または jsonp。
 

*2 複数指定可能パラメータの指定方法
name=value1,value2,...

サンプルクエリ

https://ws.ponpare.jp/ws/wsp0100/Wst0102Action.do?key=sample&large_area=1

レスポンスフィールド

フィールド 説明
results -
number_of_results 該当件数
display_per_page レスポンス内表示件数
display_from レスポンス内表示開始番号
api_version APIバージョン
middle_area 中エリア
code 中エリアコード
name 中エリア名
large_area 大エリア
code 大エリアコード
name 大エリア名

サンプルレスポンス

小エリアAPI

リクエストURL

https://ws.ponpare.jp/ws/wsp0100/Wst0103Action.do

リクエストパラメーター

パラメーター 項目名 説明 必須
key APIキー APIキー発行機能のリリースまでは、「sample」を使用。APIキー「sample」の有効期限は2011年2月22日AM5:59を予定しております。
large_area 大エリア 大エリアコードで検索(完全一致)します。
(3個まで指定可、4個以上指定すると4個目以降無視します)。*2。
middle_area 中エリア 中エリアコードで検索(完全一致)します。
(5個まで指定可、6個以上指定すると6個目以降無視します)。*2。
※ 中エリアが存在した場合、大エリアは無視。
small_area 小エリア 小エリアコードで検索(完全一致)します。
(7個まで指定可、8個以上指定すると8個目以降無視します)。*2。
※ 小エリアが存在した場合、大エリア、中エリアは無視。
format レスポンス形式 レスポンスをXMLかJSONかJSONPかを指定します。
JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。
初期値:xml。xml または json または jsonp。

*2 複数指定可能パラメータの指定方法
name=value1,value2,...

サンプルクエリ

https://ws.ponpare.jp/ws/wsp0100/Wst0103Action.do?key=sample&middle_area=13

レスポンスフィールド

フィールド 説明
results -
number_of_results 該当件数
display_per_page レスポンス内表示件数
display_from レスポンス内表示開始番号
api_version APIバージョン
small_area 小エリア
code 小エリアコード
name 小エリア名
middle_area 中エリア
code 中エリアコード
name 中エリア名
large_area 大エリア
code 大エリアコード
name 大エリア名

サンプルレスポンス